Trigger health check for OCI registry

POST

/api/v1/registries/oci/{id}/health-check

const url = 'http://localhost:3000/api/v1/registries/oci/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/health-check';
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/registries/oci/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/health-check \
  --header 'X-API-Key: <X-API-Key>'

Triggers a manual health check for an OCI registry. Checks connectivity using the OCI Distribution Spec /v2/ endpoint.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

OCI registry UUID

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

200

Health check completed successfully

application/json

object

healthy

required

Whether the registry is healthy

boolean

status

required

Health status of the registry

string

Allowed values: healthy unhealthy unknown

error

Error message if the health check failed

string

responseTimeMs

Response time in milliseconds

number

pull

FM-1265: the pull verification of this check (absent when the probe could not decide)

object

Example

{
  "healthy": true,
  "status": "healthy",
  "error": "Connection timed out (10s)",
  "responseTimeMs": 150,
  "pull": {
    "pullVerified": "FALSE",
    "pullVerifiedRepository": "team/app",
    "pullVerifiedDetail": null
  }
}

401

Unauthorized

403

Forbidden

Forbidden — caller lacks required permission

404

OCI registry not found

503

Application service unavailable