Skip to content

Delivery keys

Delivery keys in the management API. 6 endpoints.

Read the guideOpenAPI 3.1 document

Try it settings

https://api.bifrostorbit.com/cms/manage/v1

The management API takes a management token, which is secret and acts as a person, so nothing here is sent from the docs.

Try it sends each request straight from your browser to the API. The key stays in this page's memory: it is never saved, never sent to docs.bifrostorbit.com and gone when you leave or reload the page. Only reads are run; anything that changes data is described and never sent.

The space's delivery keys

GET/organisations/{organisationId}/spaces/{spaceId}/api-keysKey required

The space's delivery keys. Permission: apikey:read.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

Responses

  • 200OKList of keys.
    • dataApiKey[]

      Fields of data
      • idstring

        An id.

      • namestring

      • prefixstring

        Such as cms_pk_3f9a.

      • environmentIdstring

        An id.

      • environmentNamestring

      • scopesstring[]

      • allowDraftboolean

        A secret key that reads drafts.

      • regionIdsstring[] or null

      • localeIdsstring[] or null

      • expiresAtstring or null

      • lastUsedAtstring or null

      • revokedAtstring or null

      • createdAtstring

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks apikey:read.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such space, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/api-keys' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": [    {      "id": "6650f1c2a9e4b1d2c3f40a46",      "name": "northwilds.com",      "prefix": "cms_pk_3f9a",      "environmentId": "6650f1c2a9e4b1d2c3f40a13",      "environmentName": "Production",      "scopes": [        "content:read"      ],      "allowDraft": true,      "regionIds": [        "6650f1c2a9e4b1d2c3f40a17"      ],      "localeIds": [        "6650f1c2a9e4b1d2c3f40a18"      ],      "expiresAt": "2026-11-02T09:30:00.000Z",      "lastUsedAt": "2026-11-02T09:30:00.000Z",      "revokedAt": "2026-11-02T09:30:00.000Z",      "createdAt": "2026-11-02T09:30:00.000Z"    }  ]}

Creates a key

POST/organisations/{organisationId}/spaces/{spaceId}/api-keysKey required

Creates a key. Permission: apikey:manage.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • Idempotency-Keystringheader

    Optional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.

    Up to 255 characters.

Request body

  • namestringrequired

    Such as northwilds.com.

    Up to 200 characters.
  • environmentIdstringrequired

    The environment it reads.

  • scopesstring[]optional

    Add content:read_draft for a secret key that reads drafts. Not for a production environment.

    Default ["content:read"].
  • regionIdsstring[] or nulloptional

    Only these regions, or null for all.

  • localeIdsstring[] or nulloptional

    Only these languages, or null for all.

  • expiresAtanyoptional

    In the future, or null for never.

    Default null.

Responses

  • 201Created{ key, token }.
    • dataobject

      Fields of data
      • keyApiKey

        Fields of ApiKey

      • tokenstring

        The key, starting with cms_pk_ (public) or cms_sk_ (secret). Shown only in this answer.

  • 400Bad requestThe body isn't valid JSON. Or a draft-reading key for production, or an expiry in the past.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks apikey:manage, or the plan's active keys are used up.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such space, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 422UnprocessableThe body doesn't match the schema. Each problem is in error.details.issues.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/api-keys' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"name":"northwilds.com","environmentId":"6650f1c2a9e4b1d2c3f40a13"}'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

201 CreatedJSON
{  "data": {    "key": {      "id": "6650f1c2a9e4b1d2c3f40a40",      "name": "Lofoten sea kayaking",      "prefix": "…",      "environmentId": "6650f1c2a9e4b1d2c3f40a13",      "environmentName": "…",      "scopes": [        "content:read"      ],      "allowDraft": true,      "regionIds": [        "6650f1c2a9e4b1d2c3f40a17"      ],      "localeIds": [        "6650f1c2a9e4b1d2c3f40a18"      ],      "expiresAt": "2026-11-02T09:30:00.000Z",      "lastUsedAt": "2026-11-02T09:30:00.000Z",      "revokedAt": "2026-11-02T09:30:00.000Z",      "createdAt": "2026-11-02T09:30:00.000Z"    },    "token": "cms_pk_…"  }}

Revokes it, at once and for good

DELETE/organisations/{organisationId}/spaces/{spaceId}/api-keys/{apiKeyId}Key required

Revokes it, at once and for good. Permission: apikey:manage.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • apiKeyIdstringpath, required

    The api key's id.

Responses

  • 204No contentDone, nothing to return.
  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks apikey:manage, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such api key, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/api-keys/6650f1c2a9e4b1d2c3f40a30' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Renames it: { "name": "…" }

PATCH/organisations/{organisationId}/spaces/{spaceId}/api-keys/{apiKeyId}Key required

Renames it: { "name": "…" }. Permission: apikey:manage.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • apiKeyIdstringpath, required

    The api key's id.

  • Idempotency-Keystringheader

    Optional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.

    Up to 255 characters.

Request body

  • namestringrequired

    Up to 200 characters.

Responses

  • 204No contentDone, nothing to return.
  • 400Bad requestThe body isn't valid JSON.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks apikey:manage, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such api key, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 422UnprocessableThe body doesn't match the schema. Each problem is in error.details.issues.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X PATCH 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/api-keys/6650f1c2a9e4b1d2c3f40a30' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"name":"northwilds.com website"}'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Removes a revoked key from the list

POST/organisations/{organisationId}/spaces/{spaceId}/api-keys/{apiKeyId}/removeKey required

Removes a revoked key from the list. Permission: apikey:delete.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • apiKeyIdstringpath, required

    The api key's id.

  • Idempotency-Keystringheader

    Optional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.

    Up to 255 characters.

Responses

  • 204No contentDone, nothing to return.
  • 400Bad requestRevoke the key first.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks apikey:delete, which Admins and Owners have.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such api key, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/api-keys/6650f1c2a9e4b1d2c3f40a30/remove' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Puts a removed key back in the list, still revoked

POST/organisations/{organisationId}/spaces/{spaceId}/api-keys/{apiKeyId}/restoreKey required

Puts a removed key back in the list, still revoked. Permission: apikey:delete.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • spaceIdstringpath, required

    The space's id.

  • apiKeyIdstringpath, required

    The api key's id.

  • Idempotency-Keystringheader

    Optional. A unique value, such as a UUID, that makes a retry safe: the same key with the same request within 24 hours returns the first answer again, with Idempotent-Replayed: true, instead of making the change twice. The same key with a different request gets 422; while the first request is still running, 409. Only successful answers are kept.

    Up to 255 characters.

Responses

  • 204No contentDone, nothing to return.
  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks apikey:delete, or the token is read only.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such api key, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/api-keys/6650f1c2a9e4b1d2c3f40a30/restore' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

SchemasThe shapes the endpoints above answer with and take.

Error

Every error has this shape. Write code against code and the status, never the message.

  • errorobject

    Fields of error
    • codestring

      One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
    • messagestring

      Follows Accept-Language when CMS Orbit has the language.

    • detailsanysometimes

      When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

ApiKey

  • idstring

    An id.

  • namestring

  • prefixstring

    Such as cms_pk_3f9a.

  • environmentIdstring

    An id.

  • environmentNamestring

  • scopesstring[]

  • allowDraftboolean

    A secret key that reads drafts.

  • regionIdsstring[] or null

  • localeIdsstring[] or null

  • expiresAtstring or null

  • lastUsedAtstring or null

  • revokedAtstring or null

  • createdAtstring