List global OCI registries

GET

/api/v1/global-registries/oci

const url = 'http://localhost:3000/api/v1/global-registries/oci?name=docker&registryType=GENERIC&authType=NONE&search=hub&limit=20&offset=0';
const options = {method: 'GET', 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 GET \
  --url 'http://localhost:3000/api/v1/global-registries/oci?name=docker&registryType=GENERIC&authType=NONE&search=hub&limit=20&offset=0' \
  --header 'X-API-Key: <X-API-Key>'

Retrieves a list of all global OCI registries. Requires Super Admin privileges.

Authorizations

api-key
bearer

Parameters

Query Parameters

name

string

Example

docker

Filter by name (partial match)

enabled

boolean

Filter by enabled status

registryType

string

Allowed values: GENERIC

Filter by registry type

authType

string

Allowed values: NONE BASIC TOKEN

Filter by authentication type

mandatory

boolean

Filter by mandatory status

search

string

Example

hub

Search across name, URL, and description

limit

number

default: 20 >= 1 <= 100

Number of items to return

offset

number

Number of items to skip

cursor

string

Cursor for pagination (registry ID)

Responses

200

OCI registries retrieved successfully

application/json

object

items

required

List of global OCI registries

Array<object>

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

total

required

Total number of registries matching the query

number

limit

required

Number of items returned

number

offset

required

Number of items skipped

number

hasMore

required

Whether there are more items

boolean

nextCursor

Cursor for fetching next page

string

Example

{
  "items": [
    {
      "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": []
    }
  ],
  "total": 10,
  "limit": 20,
  "offset": 0,
  "hasMore": false,
  "nextCursor": "550e8400-e29b-41d4-a716-446655440000"
}

401

Unauthorized

403

Forbidden - Super Admin required