Report unsupported runtime reload

POST

/admin/v1/reload

const url = 'https://example.com/admin/v1/reload';
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 https://example.com/admin/v1/reload \
  --header 'X-Api-Key: <X-Api-Key>'

Standalone mode does not support runtime configuration reload. Operators should call /admin/v1/capabilities before invoking product-specific reload operations.

Authorizations

apiKeyAuth
bearerAuth

Responses

401

Missing or invalid credential

application/problem+json

object

code

required

string

detail

required

string

request_id

required

string

status

required

integer format: int32

title

required

string

type

required

string format: uri

key

additional properties

any

Example

{
  "code": "auth.missing_credential",
  "detail": "missing authentication credential",
  "status": 401,
  "title": "Missing credential",
  "type": "https://docs.registry-notary.dev/problems/auth/missing_credential"
}

403

Caller lacks registry_notary:admin scope

application/problem+json

object

code

required

string

detail

required

string

request_id

required

string

status

required

integer format: int32

title

required

string

type

required

string format: uri

key

additional properties

any

Example

{
  "code": "auth.scope_denied",
  "detail": "missing required scope",
  "status": 403,
  "title": "Scope denied",
  "type": "https://docs.registry-notary.dev/problems/auth/scope_denied"
}

501

Runtime configuration reload is not supported

application/problem+json

object

code

required

string

detail

required

string

request_id

required

string

status

required

integer format: int32

title

required

string

type

required

string format: uri

key

additional properties

any

Example

{
  "code": "registry.admin.capability.not_supported",
  "detail": "registry-notary standalone runtime does not support reload",
  "message": "registry-notary standalone runtime does not support reload",
  "schema": "registry.admin.error.v1",
  "status": 501,
  "title": "Admin capability not supported",
  "type": "https://docs.registry-notary.dev/problems/registry/admin/capability/not_supported"
}