Container Registry API, REST: ScanPolicy.get
Returns the specified scan policy.
HTTP request
GET https://container-registry.api.il.nebius.cloud/container-registry/v1/scanPolicies/{scanPolicyId}
Path parameters
| Parameter | Description |
|---|---|
| scanPolicyId | Required. ID of the scan policy. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"registryId": "string",
"name": "string",
"description": "string",
"rules": {
"pushRule": {
"repositoryPrefixes": [
"string"
],
"disabled": true
},
"scheduleRules": [
{
"repositoryPrefixes": [
"string"
],
"rescanPeriod": "string",
"disabled": true
}
]
},
"createdAt": "string",
"disabled": true
}
| Field | Description |
|---|---|
| id | string Output only. ID of the scan policy. |
| registryId | string ID of the registry that the scan policy belongs to. Required. The maximum string length in characters is 50. |
| name | string Name of the scan policy. |
| description | string Description of the scan policy. The maximum string length in characters is 256. |
| rules | object The rules of scan policy. |
| rules. pushRule |
object Description of on-push scan rule. |
| rules. pushRule. repositoryPrefixes[] |
string Required. List of repositories that are scanned with rule. Child repositories are included into parent node. "*" - means all repositories in registry Must contain at least one element. Each value must match the regular expression |
| rules. pushRule. disabled |
boolean (boolean) Turns off scan rule. |
| rules. scheduleRules[] |
object Description of time based rescan rule. |
| rules. scheduleRules[]. repositoryPrefixes[] |
string Required. List of repositories that are scanned with rule. Child repositories are included into parent node. "*" - means all repositories in registry Must contain at least one element. Each value must match the regular expression |
| rules. scheduleRules[]. rescanPeriod |
string Required. Period of time since last scan to trigger automatic rescan. |
| rules. scheduleRules[]. disabled |
boolean (boolean) Turns off scan rule. |
| createdAt | string (date-time) Output only. Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
| disabled | boolean (boolean) Turns off scan policy. |