Discuss with expertTry it for free
© 2026 Direct Cursus Technology L.L.C.

Container Registry API, REST: ScanPolicy.Get

Written by
Updated at June 3, 2026
View in Markdown

Returns the specified scan policy.

HTTP request

GET https://container-registry.api.cloud.yandex.net/container-registry/v1/scanPolicies/{scanPolicyId}

Path parameters

Field

Description

scanPolicyId

string

Required field. 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": "boolean"
    },
    "scheduleRules": [
      {
        "repositoryPrefixes": [
          "string"
        ],
        "rescanPeriod": "string",
        "disabled": "boolean"
      }
    ]
  },
  "createdAt": "string",
  "disabled": "boolean"
}

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

ScanRules

The rules of scan policy.

createdAt

string (date-time)

Output only. Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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

Turns off scan policy.

ScanRules

Field

Description

pushRule

PushRule

Description of on-push scan rule.

scheduleRules[]

ScheduledRule

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

Each value must match the regular expression \*|[a-z0-9]+(?:[._-][a-z0-9]+)*(/([a-z0-9]+(?:[._-][a-z0-9]+)*))*. The number of elements must be greater than 0.

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

Each value must match the regular expression \*|[a-z0-9]+(?:[._-][a-z0-9]+)*(/([a-z0-9]+(?:[._-][a-z0-9]+)*))*. The number of elements must be greater than 0.

rescanPeriod

string (duration)

Required field. Period of time since last scan to trigger automatic rescan.

disabled

boolean

Turns off scan rule.
Previous
Overview
Next
GetByRegistry