Skip to navigation
API ReferenceContainer Registry

Get registry security settings

Returns the vulnerability pull policy. Scanning and SBOM generation always run on push. Requires scope: container-registry.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# REGISTRY_ID: Registry ID
curl "https://api.ibee.ai/v1/container-registry/registries/$REGISTRY_ID/security/settings?workspace_id=$WORKSPACE_ID" \
  -H "Authorization: Bearer $IBEE_API_TOKEN"

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

registry_idstringRequiredformat: "uuid"
Registry ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

Response

Settings returned.
vulnerability_pull_policyenum

ALLOW pulls every image. BLOCK_<SEVERITY> refuses pulls of images with a finding at or above that severity.

Allowed values:
scan_on_pushboolean
Whether pushed images are scanned for vulnerabilities automatically.
sbom_generation_on_pushboolean
Whether an SBOM is generated for pushed images automatically.
observed_stateenum

State the registry service has actually reached.

  • PROVISIONING: being created.
  • UPDATING: a change is being applied.
  • DELETING: being removed.
  • ACTIVE: ready.
  • ERROR: the last change failed.
  • DELETED: removed.
generationinteger
Incremented by every accepted settings change.
observed_generationinteger

The last generation applied; equal to generation when settled.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
503
Service Unavailable Error