Trigger sync for OCI registry

POST

/api/v1/registries/oci/{id}/sync

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

Triggers a manual sync operation for an OCI registry. This discovers applications in the registry and imports them to the catalog.

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

Sync operation completed successfully

application/json

object

success

required

Whether the sync operation completed successfully

boolean

registryId

required

The ID of the registry that was synced

string

repositoriesFound

required

Number of OCI repositories found in the registry

number

applicationsFound

required

Number of applications found in the registry

number

applicationsImported

required

Number of new applications imported

number

applicationsUpdated

required

Number of existing applications updated

number

versionsRemoved

required

Number of versions soft-deleted because no source provides them any more and they have no active deployments

number

versionsMarkedUnavailable

required

Number of versions kept but flagged SOURCE_UNAVAILABLE because an active deployment still references them

number

applicationsRemoved

required

Number of applications removed from the catalogue because their last version disappeared from the registry

number

errors

required

Array of error messages encountered during sync

Array<string>

syncDuration

required

Duration of the sync operation in milliseconds

number

Example

{
  "success": true,
  "registryId": "550e8400-e29b-41d4-a716-446655440000",
  "repositoriesFound": 10,
  "applicationsFound": 5,
  "applicationsImported": 2,
  "applicationsUpdated": 3,
  "versionsRemoved": 0,
  "versionsMarkedUnavailable": 0,
  "applicationsRemoved": 0,
  "errors": [],
  "syncDuration": 1234
}

401

Unauthorized

403

Forbidden

Forbidden — caller lacks required permission

404

OCI registry not found

409

OCI registry is disabled

503

Application service unavailable