Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
  • Blog
  • Pricing
  • Documentation
Yandex project
© 2025 Yandex.Cloud LLC
Yandex Container Registry
  • Getting started
  • Yandex Container Solution
  • Access management
  • Pricing policy
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • GetByRegistry
        • Create
        • Update
        • Delete
  • Monitoring metrics
  • Audit Trails events
  • Troubleshooting
  • FAQ

In this article:

  • HTTP request
  • Path parameters
  • Response
  • ScanRules
  • PushRule
  • ScheduledRule
  1. API reference
  2. REST
  3. ScanPolicy
  4. GetByRegistry

Container Registry API, REST: ScanPolicy.GetByRegistry

Written by
Yandex Cloud
Updated at November 26, 2024
  • HTTP request
  • Path parameters
  • Response
  • ScanRules
  • PushRule
  • ScheduledRule

Returns scan policy for the registry if any exists.

HTTP requestHTTP request

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

Path parametersPath parameters

Field

Description

registryId

string

Required field. ID of the registry with scan policy.

ResponseResponse

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.

ScanRulesScanRules

Field

Description

pushRule

PushRule

Description of on-push scan rule.

scheduleRules[]

ScheduledRule

Description of time based rescan rule.

PushRulePushRule

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.

ScheduledRuleScheduledRule

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.

Was the article helpful?

Previous
Get
Next
Create
Yandex project
© 2025 Yandex.Cloud LLC