Container Registry API, REST: ScanPolicy.Create
Creates a scan policy for the specified registry.
HTTP request
POST https://container-registry.api.cloud.yandex.net/container-registry/v1/scanPolicies
Body parameters
{
"registryId": "string",
"name": "string",
"description": "string",
"rules": {
"pushRule": {
"repositoryPrefixes": [
"string"
],
"disabled": "boolean"
},
"scheduleRules": [
{
"repositoryPrefixes": [
"string"
],
"rescanPeriod": "string",
"disabled": "boolean"
}
]
}
}
Field |
Description |
registryId |
string Required field. ID of the scan policy registry. |
name |
string Name of the scan policy. |
description |
string Description of the scan policy. |
rules |
Rules of the scan policy. |
ScanRules
Field |
Description |
pushRule |
Description of on-push scan rule. |
scheduleRules[] |
Description of time based rescan rule. |
PushRule
Field |
Description |
repositoryPrefixes[] |
string List of repositories that are scanned with rule. Child repositories are included into parent node. "*" - means all repositories in registry |
disabled |
boolean Turns off scan rule. |
ScheduledRule
Field |
Description |
repositoryPrefixes[] |
string List of repositories that are scanned with rule. Child repositories are included into parent node. "*" - means all repositories in registry |
rescanPeriod |
string (duration) Required field. Period of time since last scan to trigger automatic rescan. |
disabled |
boolean Turns off scan rule. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"scanPolicyId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
"registryId": "string",
"name": "string",
"description": "string",
"rules": {
"pushRule": {
"repositoryPrefixes": [
"string"
],
"disabled": "boolean"
},
"scheduleRules": [
{
"repositoryPrefixes": [
"string"
],
"rescanPeriod": "string",
"disabled": "boolean"
}
]
},
"createdAt": "string",
"disabled": "boolean"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
CreateScanPolicyMetadata
Field |
Description |
scanPolicyId |
string ID of created scan policy resource. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |
ScanPolicy
Field |
Description |
id |
string Output only. ID of the scan policy. |
registryId |
string ID of the registry that the scan policy belongs to. |
name |
string Name of the scan policy. |
description |
string Description of the scan policy. |
rules |
The rules of scan policy. |
createdAt |
string (date-time) Output only. Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
disabled |
boolean Turns off scan policy. |
ScanRules
Field |
Description |
pushRule |
Description of on-push scan rule. |
scheduleRules[] |
Description of time based rescan rule. |
PushRule
Field |
Description |
repositoryPrefixes[] |
string List of repositories that are scanned with rule. Child repositories are included into parent node. "*" - means all repositories in registry |
disabled |
boolean Turns off scan rule. |
ScheduledRule
Field |
Description |
repositoryPrefixes[] |
string List of repositories that are scanned with rule. Child repositories are included into parent node. "*" - means all repositories in registry |
rescanPeriod |
string (duration) Required field. Period of time since last scan to trigger automatic rescan. |
disabled |
boolean Turns off scan rule. |