Register a registry

Discovers a registry from its base URL: fetches its well-known document, negotiates the highest supported definitions/modules capability, and stores a record. The advertised id is used unless an explicit id override is supplied. The base URL is validated and normalized before storage. When auth credentials are supplied, the well-known auth advertisement is validated first: safety refusals (plaintext transport, method mismatch, a requested oauth2 scope the registry does not advertise) fail the request with 400, while a failed live token exchange still stores the record and reports error status on the auth field.

POST /registries

Register a registry

cURL

curl --request POST \
  --url http://localhost:9371/registries \
  --header 'Content-Type: application/json' \
  --data '
{
  "baseUrl": "<string>",
  "id": "<string>",
  "auth": {
    "type": "apiKey",
    "apiKey": "<string>"
  }
}
'

201

{
  "id": "<string>",
  "baseUrl": "<string>",
  "lastSyncedAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "authType": "apiKey",
  "tokenExpiresAt": 123,
  "auth": {
    "type": "apiKey",
    "status": "configured",
    "headerName": "<string>",
    "tokenExpiresAt": 123,
    "message": "<string>"
  }
}

Body

application/json

Request body used to register a registry via discovery.

baseUrl · string · required

Absolute http(s) URL of the registry. A well-known discovery document is fetched from it; the URL is normalized before storage.

Minimum string length: 1

id · string

Optional local id override. When omitted, the id advertised by the registry's well-known document is used.

Minimum string length: 1

auth · object

Optional credentials for the registry, validated against its well-known auth advertisement before storage.

Option 1

Option 2

Show child attributes

Response

201

application/json

The registry record was created.

Response body of a registry registration request.

id · string · required

Registry slug matching /^[A-Za-z0-9_-]+$/ used as the primary key.

Minimum string length: 1

baseUrl · string · required

Normalized absolute http(s) URL of the registry.

lastSyncedAt · string | null · required

ISO-8601 timestamp of the last successful sync with the registry, or null when it has never been synced.

createdAt · string · required

ISO-8601 timestamp of when the registry was registered.

updatedAt · string · required

ISO-8601 timestamp of the last mutation to the record.

authType · enum<string> | null · required

Authentication method configured for this registry, or null when none is set.

Available options: apiKey, oauth2, null

tokenExpiresAt · number | null · required

Epoch-ms timestamp when the cached OAuth2 access token expires, or null for api key auth or when no token has been fetched.

auth · object | null

Outcome of storing the credentials supplied in the request, or null when no auth was supplied.

Show child attributes