Enable global OCI registry

POST

/api/v1/global-registries/oci/{id}/enable

const url = 'http://localhost:3000/api/v1/global-registries/oci/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/enable';
const options = {method: 'POST', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:3000/api/v1/global-registries/oci/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/enable \
  --header 'X-API-Key: <X-API-Key>'

Enables a global OCI registry. Requires Super Admin privileges.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

OCI registry UUID

Responses

200

OCI registry enabled successfully

application/json

object

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": []
}

401

Unauthorized

403

Forbidden - Super Admin required

404

OCI registry not found