Create global OCI registry

POST

/api/v1/global-registries/oci

curl --request POST \
  --url http://localhost:3000/api/v1/global-registries/oci \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "name": "docker-hub", "description": "Docker Hub public registry", "url": "https://registry-1.docker.io", "registryType": "GENERIC", "authType": "NONE", "credential": "username:password", "verifyTls": true, "enabled": true, "mandatory": false, "priority": 0, "repositories": [ "library/nginx", "team/app" ] }'

• Development
• Production

Creates a new global OCI registry accessible to all tenants. Requires Super Admin privileges.

Authorizations

• api-key
• bearer

Request Body ^required

Media type application/json

object

name

required

Unique name for the registry

string

>= 2 characters <= 100 characters

Example

docker-hub

description

Description of the registry purpose

string

Example

Docker Hub public registry

url

required

Registry URL

string

Example

https://registry-1.docker.io

registryType

Registry type/provider

string

default: GENERIC

Allowed values: GENERIC

authType

Authentication type

string

default: NONE

Allowed values: NONE BASIC TOKEN

credential

Credential for authentication - will be encrypted. For BASIC auth this MUST be “username:password”. For TOKEN auth it is the raw token.

string

Example

username:password

verifyTls

Whether to verify TLS certificates

boolean

default: true

enabled

Whether the registry is enabled

boolean

default: true

mandatory

Whether this registry is mandatory for all tenants

boolean

priority

Priority in the combined registry list (lower is higher priority)

number

0 <= 1000

Example

0

repositories

Explicit repository list. When provided, sync uses these repositories directly and skips /v2/_catalog discovery.

Array<string>

Example

[
  "library/nginx",
  "team/app"
]

Responses

201

OCI registry created successfully

Media type application/json

object

id

required

Registry unique identifier

string format: uuid

name

required

Unique name for the registry

string

description

Description of the registry purpose

string

url

required

Registry URL

string

registryType

required

Registry type/provider

string

Allowed values: GENERIC

authType

required

Authentication type

string

Allowed values: NONE BASIC TOKEN

hasCredentials

required

Whether credentials are configured

boolean

verifyTls

required

Whether to verify TLS certificates

boolean

lastHealthCheck

Last health check timestamp

string format: date-time

healthStatus

Current health status

string

Allowed values: healthy unhealthy unknown

lastSyncAt

Last sync timestamp

string format: date-time

lastSyncError

Last sync error message

string

nullable

syncIntervalMinutes

required

Sync interval in minutes

number

enabled

required

Whether the registry is enabled

boolean

mandatory

required

Whether this registry is mandatory for all tenants

boolean

priority

required

Priority in the combined registry list

number

repositories

required

Explicit repository list used for sync. When non-empty, /v2/_catalog discovery is skipped.

Array<string>

createdAt

required

Creation timestamp

string format: date-time

updatedAt

required

Last update timestamp

string format: date-time

Example

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "docker-hub",
  "description": "Docker Hub public registry",
  "url": "https://registry-1.docker.io",
  "registryType": "GENERIC",
  "authType": "NONE",
  "hasCredentials": false,
  "verifyTls": true,
  "healthStatus": "healthy",
  "syncIntervalMinutes": 60,
  "enabled": true,
  "mandatory": false,
  "priority": 0,
  "repositories": []
}

400

Invalid input data

401

Unauthorized

403

Forbidden - Super Admin required

409

Registry with this name already exists