Contact UsGet started

Container Registry API, gRPC: ScanPolicyService.Create

Written by
Updated at November 26, 2024

Creates a scan policy for the specified registry.

gRPC request

rpc Create (CreateScanPolicyRequest) returns (operation.Operation)

CreateScanPolicyRequest

{
  "registry_id": "string",
  "name": "string",
  "description": "string",
  "rules": {
    "push_rule": {
      "repository_prefixes": [
        "string"
      ],
      "disabled": "bool"
    },
    "schedule_rules": [
      {
        "repository_prefixes": [
          "string"
        ],
        "rescan_period": "google.protobuf.Duration",
        "disabled": "bool"
      }
    ]
  }
}

Field

Description

registry_id

string

Required field. ID of the scan policy registry.

name

string

Name of the scan policy.

description

string

Description of the scan policy.

rules

ScanRules

Rules of the scan policy.

ScanRules

Field

Description

push_rule

PushRule

Description of on-push scan rule.

schedule_rules[]

ScheduledRule

Description of time based rescan rule.

PushRule

Field

Description

repository_prefixes[]

string

List of repositories that are scanned with rule. Child repositories are included into parent node. "*" - means all repositories in registry

disabled

bool

Turns off scan rule.

ScheduledRule

Field

Description

repository_prefixes[]

string

List of repositories that are scanned with rule. Child repositories are included into parent node. "*" - means all repositories in registry

rescan_period

google.protobuf.Duration

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

disabled

bool

Turns off scan rule.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "scan_policy_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "registry_id": "string",
    "name": "string",
    "description": "string",
    "rules": {
      "push_rule": {
        "repository_prefixes": [
          "string"
        ],
        "disabled": "bool"
      },
      "schedule_rules": [
        {
          "repository_prefixes": [
            "string"
          ],
          "rescan_period": "google.protobuf.Duration",
          "disabled": "bool"
        }
      ]
    },
    "created_at": "google.protobuf.Timestamp",
    "disabled": "bool"
  }
  // 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.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

CreateScanPolicyMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

ScanPolicy

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

CreateScanPolicyMetadata

Field

Description

scan_policy_id

string

ID of created scan policy resource.

ScanPolicy

Field

Description

id

string

Output only. ID of the scan policy.

registry_id

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.

created_at

google.protobuf.Timestamp

Output only. Creation timestamp.

disabled

bool

Turns off scan policy.

ScanRules

Field

Description

push_rule

PushRule

Description of on-push scan rule.

schedule_rules[]

ScheduledRule

Description of time based rescan rule.

PushRule

Field

Description

repository_prefixes[]

string

List of repositories that are scanned with rule. Child repositories are included into parent node. "*" - means all repositories in registry

disabled

bool

Turns off scan rule.

ScheduledRule

Field

Description

repository_prefixes[]

string

List of repositories that are scanned with rule. Child repositories are included into parent node. "*" - means all repositories in registry

rescan_period

google.protobuf.Duration

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

disabled

bool

Turns off scan rule.
Previous
GetByRegistry
Next
Update