Container registryUsers

API reference

Every HTTP endpoint of the registry module: authentication, IAM action, parameters, bodies and status codes.

Generated from the module's code when its image was built — do not edit. Paths are relative to https://api.example.com.

Docs

`GET /docs/registry/manifest.json`

Authentication: required
Operation name: DocsManifest_registry

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid

`GET /docs/registry/{path}`

Authentication: required
Operation name: DocsFile_registry

Parameters

Name	In	Type	Required
`path`	path	`string`	Yes

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid

Registry Admin

`POST /v1/internal/registries/mint-boundary-credential`

Authentication: required
Operation name: MintBoundaryCredential

Request body: MintBoundaryRequest

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid

`POST /v1/internal/registries/mint-build-token`

Authentication: required
Operation name: MintBuildToken

Request body: MintBuildRequest

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid

Registry Audit

`GET /resources/registries/audit`

Authentication: required
IAM action: registry/audit/read — evaluated at the platform root
Operation name: ListRegistryAuditEvents

Parameters

Name	In	Type	Required
`action`	query	`string`	No
`boundary`	query	`string`	No
`correlation_id`	query	`uuid`	No
`from`	query	`date-time`	No
`limit`	query	`integer`	No
`repository`	query	`string`	No
`to`	query	`date-time`	No

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid
`403`	The caller does not hold registry/audit/read at the evaluated scope

Registry Manifests

`GET /v1/internal/registries/manifests`

Authentication: required
Operation name: GetManifest

Parameters

Name	In	Type	Required
`repository`	query	`string`	No
`tag`	query	`string`	No

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid

Registry Pins

`DELETE /v1/internal/registries/pins`

Authentication: required
Operation name: DeletePins

Parameters

Name	In	Type	Required
`boundary`	query	`string`	No
`repository`	query	`string`	No

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid

`PUT /v1/internal/registries/pins`

Authentication: required
Operation name: PutPins

Request body: PinUpsertRequest

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid

Registry Retention

`GET /v1/registries/retention/preview`

Authentication: required
IAM action: registry/audit/read — evaluated at the platform root
Operation name: PreviewRetentionSweep

Parameters

Name	In	Type	Required
`boundary`	query	`string`	No
`repository`	query	`string`	No

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid
`403`	The caller does not hold registry/audit/read at the evaluated scope

`GET /v1/registries/retention/runs`

Authentication: required
IAM action: registry/audit/read — evaluated at the platform root
Operation name: ListRetentionRuns

Parameters

Name	In	Type	Required
`limit`	query	`integer`	No

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid
`403`	The caller does not hold registry/audit/read at the evaluated scope

`POST /v1/registries/retention/runs`

Authentication: required
IAM action: registry/retention/manage — evaluated at the platform root
Operation name: TriggerRetentionRun

Request body: PostRunRequest

Responses

Status	Meaning	Body
`200`	OK
`401`	Not signed in, or the token is invalid
`403`	The caller does not hold registry/retention/manage at the evaluated scope

Other endpoints

`GET /readyz`

Authentication: none — anonymous callers are accepted
Operation name: StackshipReadiness

Responses

Status	Meaning	Body

`GET /registry/auth/token`

Authentication: none — anonymous callers are accepted
Operation name: RegistryAuthTokenGet

Responses

Status	Meaning	Body
`200`	OK

`POST /registry/auth/token`

Authentication: none — anonymous callers are accepted
Operation name: RegistryAuthToken

Responses

Status	Meaning	Body
`200`	OK

`POST /v1/internal/registries/notify`

Authentication: none — anonymous callers are accepted
Operation name: RegistryNotify

Responses

Status	Meaning	Body
`200`	OK

Schemas

`MintBoundaryRequest`

Property	Type	Nullable
`boundary`	`string`	No

`MintBuildRequest`

Property	Type	Nullable
`boundary`	`string`	No
`kind`	`string`	No
`name`	`string`	No
`resourceGroup`	`string`	No

`PinUpsertRequest`

Property	Type	Nullable
`boundary`	`string`	No
`digests`	`string` `[]`	No
`expiresAt`	`date-time`	No
`keepForDays`	`integer`	Yes
`keepLast`	`integer`	Yes
`repository`	`string`	No

`PostRunRequest`

Property	Type	Nullable
`dryRun`	`boolean`	Yes