Registry API
OCI container registry
REST API endpoints for Registry. 10 operations.
Check the registry API version
GET /v1/registry/v2/Returns the OCI Distribution API version supported by the registry.
Auth: Bearer API key
Responses
| Status | Description |
|---|---|
200 | OCI Distribution API version check |
401 | Missing or invalid API key |
500 | Internal error |
operationId: registryVersionCheck
List the repository catalog
GET /v1/registry/v2/_catalogReturns the catalog of repositories in the registry.
Auth: Bearer API key
Responses
| Status | Description |
|---|---|
200 | Repository catalog |
401 | Missing or invalid API key |
500 | Internal error |
operationId: getRegistryCatalog
Get a blob
GET /v1/registry/v2/{project_id}/{repository}/blobs/{digest}Downloads an OCI blob by digest.
Auth: Bearer API key
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
project_id | path | string | Yes | Project id |
repository | path | string | Yes | Repository name |
digest | path | string | Yes | Blob digest |
Responses
| Status | Description |
|---|---|
200 | Blob content |
401 | Missing or invalid API key |
500 | Internal error |
operationId: getRegistryBlob
Check a blob exists
HEAD /v1/registry/v2/{project_id}/{repository}/blobs/{digest}Returns headers indicating whether an OCI blob exists.
Auth: Bearer API key
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
project_id | path | string | Yes | Project id |
repository | path | string | Yes | Repository name |
digest | path | string | Yes | Blob digest |
Responses
| Status | Description |
|---|---|
200 | Blob existence/headers |
401 | Missing or invalid API key |
500 | Internal error |
operationId: headRegistryBlob
Start a blob upload
POST /v1/registry/v2/{project_id}/{repository}/blobs/uploads/Begins an OCI blob upload session and returns the upload location.
Auth: Bearer API key
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
project_id | path | string | Yes | Project id |
repository | path | string | Yes | Repository name |
Responses
| Status | Description |
|---|---|
202 | Blob upload session started |
401 | Missing or invalid API key |
500 | Internal error |
operationId: startRegistryBlobUpload
Delete a manifest
DELETE /v1/registry/v2/{project_id}/{repository}/manifests/{reference}Removes an OCI image manifest by tag or digest.
Auth: Bearer API key
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
project_id | path | string | Yes | Project id |
repository | path | string | Yes | Repository name |
reference | path | string | Yes | Tag or digest |
Responses
| Status | Description |
|---|---|
202 | Manifest deleted |
401 | Missing or invalid API key |
500 | Internal error |
operationId: deleteRegistryManifest
Get a manifest
GET /v1/registry/v2/{project_id}/{repository}/manifests/{reference}Returns an OCI image manifest by tag or digest.
Auth: Bearer API key
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
project_id | path | string | Yes | Project id |
repository | path | string | Yes | Repository name |
reference | path | string | Yes | Tag or digest |
Responses
| Status | Description |
|---|---|
200 | OCI manifest |
401 | Missing or invalid API key |
500 | Internal error |
operationId: getRegistryManifest
Check a manifest exists
HEAD /v1/registry/v2/{project_id}/{repository}/manifests/{reference}Returns headers indicating whether an OCI manifest exists.
Auth: Bearer API key
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
project_id | path | string | Yes | Project id |
repository | path | string | Yes | Repository name |
reference | path | string | Yes | Tag or digest |
Responses
| Status | Description |
|---|---|
200 | Manifest existence/headers |
401 | Missing or invalid API key |
500 | Internal error |
operationId: headRegistryManifest
Store a manifest
PUT /v1/registry/v2/{project_id}/{repository}/manifests/{reference}Uploads an OCI image manifest under a tag or digest.
Auth: Bearer API key
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
project_id | path | string | Yes | Project id |
repository | path | string | Yes | Repository name |
reference | path | string | Yes | Tag or digest |
Request body
application/json (required) — schema object.
Responses
| Status | Description |
|---|---|
201 | Manifest stored |
401 | Missing or invalid API key |
500 | Internal error |
operationId: putRegistryManifest
List tags
GET /v1/registry/v2/{project_id}/{repository}/tags/listReturns the tags available for a repository.
Auth: Bearer API key
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
project_id | path | string | Yes | Project id |
repository | path | string | Yes | Repository name |
Responses
| Status | Description |
|---|---|
200 | Tag list |
401 | Missing or invalid API key |
500 | Internal error |
operationId: listRegistryTags