Skip to content

Publishing

Publishing in the management API. 8 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.

Publishes a banner at once on every page, past approval

POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/emergency-publishKey required

Publishes a banner at once on every page, past approval. Permission: emergency:publish.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item'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

  • reasonstringrequired

    Why it can't wait, 5 to 300 characters. Recorded in the audit log.

Responses

  • 200OKThe item.
    • dataContent

      One piece of content with its draft.

      Fields of data
      • idstring

        An id.

      • namestring

      • slugstring

      • urlstring or null

      • statusstring

        One of draft, in_review, published, scheduled, archived.
      • contentTypeKeystring

      • folderIdstring or null

        An id.

      • externalIdstring or null

      • isGlobalboolean

      • isFolderIndexboolean

      • updatedAtstring

      • publishedAtstring or null

      • urlOverridestring or null

      • draftobject

        The draft. No seo for content without an address.

        Fields of draft
        • fieldsmap of any

          Field values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.

        • componentsBlock[]

          Fields of Block

        • seoobjectsometimes

          Fields of seo
          • titlestring or null

          • descriptionstring or null

          • canonicalstring or null

          • noIndexboolean

          • ogTitlestring or null

          • ogDescriptionstring or null

          • ogImagestring or null

            A media id or address.

          • twitterTitlestring or null

          • twitterDescriptionstring or null

          • twitterImagestring or null

          • noFollowboolean

          • breadcrumbLabelstring or null

          • sitemapExcludeboolean

          • sitemapChangeFrequencystring or null

            One of always, hourly, daily, weekly, monthly, yearly, never.
          • sitemapPrioritynumber or null

            At least 0. At most 1.
        • updatedAtstring

        • updatedBystring

          An id.

      • draftVersioninteger

      • publishedVersioninteger

        Compare with draftVersion to see whether the draft has unpublished changes.

      • docVersioninteger

        Send it back with each save, so a save never overwrites changes you haven't seen.

  • 400Bad requestThe body isn't valid JSON. Or no reason, a reason over 300 characters, or content that isn't a banner.
    • 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 emergency:publish, 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 content item, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/emergency-publish' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"reason":"The Tromsø ferry is cancelled today because of the storm."}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a21",    "name": "Lofoten sea kayaking",    "slug": "lofoten-sea-kayaking",    "url": "/trips/lofoten-sea-kayaking",    "status": "draft",    "contentTypeKey": "trip",    "folderId": "6650f1c2a9e4b1d2c3f40a20",    "externalId": null,    "isGlobal": false,    "isFolderIndex": false,    "updatedAt": "2026-11-02T09:30:00.000Z",    "publishedAt": "2026-11-02T09:30:00.000Z",    "urlOverride": null,    "draft": {      "fields": {},      "components": [        {          "id": "hero-1",          "type": "hero",          "schemaVersion": 12,          "fields": {            "heading": "Paddle the Lofoten fjords"          },          "children": {},          "variant": null        }      ],      "seo": {        "title": "Lofoten sea kayaking",        "description": "Six days of paddling between the peaks of Lofoten.",        "canonical": null,        "noIndex": false,        "ogTitle": null,        "ogDescription": null,        "ogImage": null,        "twitterTitle": null,        "twitterDescription": null,        "twitterImage": null,        "noFollow": false,        "breadcrumbLabel": null,        "sitemapExclude": false,        "sitemapChangeFrequency": "always",        "sitemapPriority": 0      },      "updatedAt": "2026-11-02T09:30:00.000Z",      "updatedBy": "6650f1c2a9e4b1d2c3f40a30"    },    "draftVersion": 12,    "publishedVersion": 12,    "docVersion": 12  }}

Copies the published version to another environment and publishes it there

POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/promoteKey required

Copies the published version to another environment and publishes it there. Permission: content:publish in both.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item'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

  • targetEnvironmentIdstringrequired

    The environment to publish it in, such as production.

Responses

  • 200OK{ contentId, targetContentId, targetEnvironment, created }.
    • dataobject

      Fields of data
      • contentIdstring

        An id.

      • targetContentIdstring

        Its id in the other environment.

      • targetEnvironmentstring

        The other environment's name.

      • createdboolean

        It didn't exist there before.

  • 400Bad requestThe body isn't valid JSON. Or the same environment, or the other environment lacks the region or language.
    • 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 content:publish here or there.
    • 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 content item, 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.

  • 409ConflictIt isn't published here, or another page uses the address there.
    • 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/promote' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"targetEnvironmentId":"6650f1c2a9e4b1d2c3f40a14"}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "contentId": "6650f1c2a9e4b1d2c3f40a21",    "targetContentId": "6650f1c2a9e4b1d2c3f40a5f",    "targetEnvironment": "…",    "created": true  }}

Promotes every published entry in a folder or language to another environment, with their redirects

POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/promoteKey required

Promotes every published entry in a folder or language to another environment, with their redirects. Permission: content:publish in both, redirect:manage for redirects.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language'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

  • targetEnvironmentIdstringrequired

    The environment to publish in, such as production.

  • folderIdstring or nulloptional

    Promote this folder and every folder in it. Leave it out, or send null, for every entry in this language.

  • redirectsbooleanoptional

    Also copy the redirects to the pages promoted, or for a whole language every redirect in it. Needs redirect:manage; without it they are left out and redirectsSkipped is true.

    Default true.
  • dryRunbooleanoptional

    Answer what would happen without changing anything.

    Default false.
  • afterstring or nulloptional

    The next value of the previous answer. Each call handles up to 100 entries, fewer when they take more than 30 seconds.

Responses

  • 200OK{ dryRun, target, total, items, next, redirects, redirectsSkipped }.
    • dataobject

      Fields of data
      • dryRunboolean

      • targetstring

        The other environment's name.

      • totalinteger

        Entries in the folder or language, across every call.

      • itemsobject[]

        The entries handled by this call.

        Fields of items
        • contentIdstring

          An id.

        • namestring

        • urlstring or null

        • outcomestring

          unchanged when the other environment already has what is published here; notPublished entries are left out.

          One of create, update, unchanged, notPublished, error.
        • messagestring or null

          Why it failed.

      • nextstring or null

        Send it as after to handle the next 100. null on the last call.

      • redirectsobject or null

        On the last call, when redirects is true.

        Fields of redirects
        • createinteger

        • updateinteger

        • unchangedinteger

        • errorinteger

      • redirectsSkippedboolean

        Redirects were asked for without redirect:manage.

  • 400Bad requestThe body isn't valid JSON. Or the same environment, or the other environment lacks the region or language.
    • 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 content:publish here or there.
    • 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 environment or folder.
    • 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/promote' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"targetEnvironmentId":"6650f1c2a9e4b1d2c3f40a14","folderId":"6650f1c2a9e4b1d2c3f40a20","dryRun":true}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "dryRun": false,    "target": "…",    "total": 4,    "items": [      {        "contentId": "6650f1c2a9e4b1d2c3f40a21",        "name": "Lofoten sea kayaking",        "url": "https://northwilds.com/trips/lofoten-sea-kayaking",        "outcome": "create",        "message": null      }    ],    "next": null,    "redirects": {      "create": 1,      "update": 1,      "unchanged": 1,      "error": 1    },    "redirectsSkipped": false  }}

Publishes the draft

POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/publishKey required

Publishes the draft. Permission: content:publish.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item'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, optional

  • changeSummarystring or nulloptional

    What changed, shown in the history.

    Up to 300 characters.
  • summaryKindstringoptional

    Used by the CMS screens.

    One of siteSettings, allSiteSettings.
  • accessibilityOverrideobjectoptional

    Publish despite accessibility problems that would block it. Needs space:update.

    Fields of accessibilityOverride
    • reasonstringrequired

      Up to 500 characters.
  • expectedDraftVersionintegeroptional

    The draftVersion you last read. If the page changed since, the answer is 409 draft_changed and nothing is published.

    At least 0.

Responses

  • 200OKThe item, with redirect.
    • dataobject

      The item, with the redirect publishing added.

      Fields of data
      • idstring

        An id.

      • namestring

      • slugstring

      • urlstring or null

      • statusstring

        One of draft, in_review, published, scheduled, archived.
      • contentTypeKeystring

      • folderIdstring or null

        An id.

      • externalIdstring or null

      • isGlobalboolean

      • isFolderIndexboolean

      • updatedAtstring

      • publishedAtstring or null

      • urlOverridestring or null

      • draftobject

        The draft. No seo for content without an address.

        Fields of draft
        • fieldsmap of any

          Field values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.

        • componentsBlock[]

          Fields of Block

        • seoobjectsometimes

          Fields of seo
          • titlestring or null

          • descriptionstring or null

          • canonicalstring or null

          • noIndexboolean

          • ogTitlestring or null

          • ogDescriptionstring or null

          • ogImagestring or null

            A media id or address.

          • twitterTitlestring or null

          • twitterDescriptionstring or null

          • twitterImagestring or null

          • noFollowboolean

          • breadcrumbLabelstring or null

          • sitemapExcludeboolean

          • sitemapChangeFrequencystring or null

            One of always, hourly, daily, weekly, monthly, yearly, never.
          • sitemapPrioritynumber or null

            At least 0. At most 1.
        • updatedAtstring

        • updatedBystring

          An id.

      • draftVersioninteger

      • publishedVersioninteger

        Compare with draftVersion to see whether the draft has unpublished changes.

      • docVersioninteger

        Send it back with each save, so a save never overwrites changes you haven't seen.

      • redirectobject or null

        The redirect added because the address changed, when the space adds them.

        Fields of redirect
        • idstring

          An id.

        • sourcestring

        • destinationstring

  • 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 content:publish, or the plan's limits.
    • 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 content item, 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.

  • 409ConflictNothing new to publish, it needs approval or sign-off, a check blocks it (details.blockers), or accessibility problems block it (details.accessibility and details.canOverride).
    • 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/publish' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"changeSummary":"New departures for 2027."}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a40",    "name": "Lofoten sea kayaking",    "slug": "lofoten-sea-kayaking",    "url": "https://northwilds.com/trips/lofoten-sea-kayaking",    "status": "draft",    "contentTypeKey": "…",    "folderId": "6650f1c2a9e4b1d2c3f40a20",    "externalId": null,    "isGlobal": false,    "isFolderIndex": false,    "updatedAt": "2026-11-02T09:30:00.000Z",    "publishedAt": "2026-11-02T09:30:00.000Z",    "urlOverride": null,    "draft": {      "fields": {},      "components": [        {          "id": "hero-1",          "type": "hero",          "schemaVersion": 12,          "fields": {            "heading": "Paddle the Lofoten fjords"          },          "children": {},          "variant": null        }      ],      "seo": {        "title": "Lofoten sea kayaking",        "description": "Six days of paddling between the peaks of Lofoten.",        "canonical": null,        "noIndex": false,        "ogTitle": null,        "ogDescription": null,        "ogImage": null,        "twitterTitle": null,        "twitterDescription": null,        "twitterImage": null,        "noFollow": false,        "breadcrumbLabel": null,        "sitemapExclude": false,        "sitemapChangeFrequency": "always",        "sitemapPriority": 0      },      "updatedAt": "2026-11-02T09:30:00.000Z",      "updatedBy": "6650f1c2a9e4b1d2c3f40a30"    },    "draftVersion": 12,    "publishedVersion": 12,    "docVersion": 12,    "redirect": {      "id": "6650f1c2a9e4b1d2c3f40a40",      "source": "…",      "destination": "…"    }  }}

Puts an earlier revision back

POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/rollbackKey required

Puts an earlier revision back. Permission: content:rollback.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item'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

  • revisionIdstringrequired

    The revision to put back. When the page is live, it's published straight away.

  • changeSummarystring or nulloptional

    Up to 300 characters.

Responses

  • 200OKThe item.
    • dataContent

      One piece of content with its draft.

      Fields of data
      • idstring

        An id.

      • namestring

      • slugstring

      • urlstring or null

      • statusstring

        One of draft, in_review, published, scheduled, archived.
      • contentTypeKeystring

      • folderIdstring or null

        An id.

      • externalIdstring or null

      • isGlobalboolean

      • isFolderIndexboolean

      • updatedAtstring

      • publishedAtstring or null

      • urlOverridestring or null

      • draftobject

        The draft. No seo for content without an address.

        Fields of draft
        • fieldsmap of any

          Field values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.

        • componentsBlock[]

          Fields of Block

        • seoobjectsometimes

          Fields of seo
          • titlestring or null

          • descriptionstring or null

          • canonicalstring or null

          • noIndexboolean

          • ogTitlestring or null

          • ogDescriptionstring or null

          • ogImagestring or null

            A media id or address.

          • twitterTitlestring or null

          • twitterDescriptionstring or null

          • twitterImagestring or null

          • noFollowboolean

          • breadcrumbLabelstring or null

          • sitemapExcludeboolean

          • sitemapChangeFrequencystring or null

            One of always, hourly, daily, weekly, monthly, yearly, never.
          • sitemapPrioritynumber or null

            At least 0. At most 1.
        • updatedAtstring

        • updatedBystring

          An id.

      • draftVersioninteger

      • publishedVersioninteger

        Compare with draftVersion to see whether the draft has unpublished changes.

      • docVersioninteger

        Send it back with each save, so a save never overwrites changes you haven't seen.

  • 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 content:rollback, 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 content item, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/rollback' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"revisionId":"6650f1c2a9e4b1d2c3f40a30","changeSummary":"Back to the summer prices."}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a21",    "name": "Lofoten sea kayaking",    "slug": "lofoten-sea-kayaking",    "url": "/trips/lofoten-sea-kayaking",    "status": "draft",    "contentTypeKey": "trip",    "folderId": "6650f1c2a9e4b1d2c3f40a20",    "externalId": null,    "isGlobal": false,    "isFolderIndex": false,    "updatedAt": "2026-11-02T09:30:00.000Z",    "publishedAt": "2026-11-02T09:30:00.000Z",    "urlOverride": null,    "draft": {      "fields": {},      "components": [        {          "id": "hero-1",          "type": "hero",          "schemaVersion": 12,          "fields": {            "heading": "Paddle the Lofoten fjords"          },          "children": {},          "variant": null        }      ],      "seo": {        "title": "Lofoten sea kayaking",        "description": "Six days of paddling between the peaks of Lofoten.",        "canonical": null,        "noIndex": false,        "ogTitle": null,        "ogDescription": null,        "ogImage": null,        "twitterTitle": null,        "twitterDescription": null,        "twitterImage": null,        "noFollow": false,        "breadcrumbLabel": null,        "sitemapExclude": false,        "sitemapChangeFrequency": "always",        "sitemapPriority": 0      },      "updatedAt": "2026-11-02T09:30:00.000Z",      "updatedBy": "6650f1c2a9e4b1d2c3f40a30"    },    "draftVersion": 12,    "publishedVersion": 12,    "docVersion": 12  }}

Its scheduled publishing and unpublishing

GET/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/scheduleKey required

Its scheduled publishing and unpublishing. Permission: release:read.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item's id.

Responses

  • 200OK[{ releaseId, action, at, sharedWith }].
    • dataSchedule[]

      Fields of data
      • releaseIdstring

        The release it's in.

      • actionstring

        One of publish, unpublish.
      • atstring

      • sharedWithinteger

        Other pages in the same release.

  • 400Bad requestNot a content id.
    • 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 release: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 content item, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/schedule' \  -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": [    {      "releaseId": "6650f1c2a9e4b1d2c3f40a59",      "action": "publish",      "at": "2026-11-02T09:30:00.000Z",      "sharedWith": 1    }  ]}

Publishes or unpublishes it at a time

POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/scheduleKey required

Publishes or unpublishes it at a time. Permission: content:publish or content:unpublish, and release:manage.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item'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

  • atstringrequired

    When, in the future, ISO 8601 with a time zone. Required.

  • actionstringoptional

    Default publish.

    One of publish, unpublish.

Responses

  • 201Created{ releaseId, action, at, sharedWith }.
    • dataSchedule

      Fields of data
      • releaseIdstring

        The release it's in.

      • actionstring

        One of publish, unpublish.
      • atstring

      • sharedWithinteger

        Other pages in the same release.

  • 400Bad requestThe body isn't valid JSON. Or no date and time, or one 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 content:publish or content:unpublish, release:manage, or the plan has no releases.
    • 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 content item, 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/schedule' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"at":"2026-12-01T08:00:00Z","action":"publish"}'

Try it

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

Example answer

201 CreatedJSON
{  "data": {    "releaseId": "6650f1c2a9e4b1d2c3f40a59",    "action": "publish",    "at": "2026-11-02T09:30:00.000Z",    "sharedWith": 1  }}

Takes it off the website

POST/organisations/{organisationId}/spaces/{spaceId}/environments/{environmentId}/regions/{regionId}/locales/{localeId}/content/{contentId}/unpublishKey required

Takes it off the website. redirectTo adds a redirect. Permission: content:unpublish.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringpath, required

    The environment's id.

  • regionIdstringpath, required

    The region's id.

  • localeIdstringpath, required

    The language's id.

  • contentIdstringpath, required

    The content item'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, optional

  • redirectTostring or nulloptional

    Also add a redirect from its address to this one, such as /trips.

Responses

  • 200OKThe item.
    • dataContent

      One piece of content with its draft.

      Fields of data
      • idstring

        An id.

      • namestring

      • slugstring

      • urlstring or null

      • statusstring

        One of draft, in_review, published, scheduled, archived.
      • contentTypeKeystring

      • folderIdstring or null

        An id.

      • externalIdstring or null

      • isGlobalboolean

      • isFolderIndexboolean

      • updatedAtstring

      • publishedAtstring or null

      • urlOverridestring or null

      • draftobject

        The draft. No seo for content without an address.

        Fields of draft
        • fieldsmap of any

          Field values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.

        • componentsBlock[]

          Fields of Block

        • seoobjectsometimes

          Fields of seo
          • titlestring or null

          • descriptionstring or null

          • canonicalstring or null

          • noIndexboolean

          • ogTitlestring or null

          • ogDescriptionstring or null

          • ogImagestring or null

            A media id or address.

          • twitterTitlestring or null

          • twitterDescriptionstring or null

          • twitterImagestring or null

          • noFollowboolean

          • breadcrumbLabelstring or null

          • sitemapExcludeboolean

          • sitemapChangeFrequencystring or null

            One of always, hourly, daily, weekly, monthly, yearly, never.
          • sitemapPrioritynumber or null

            At least 0. At most 1.
        • updatedAtstring

        • updatedBystring

          An id.

      • draftVersioninteger

      • publishedVersioninteger

        Compare with draftVersion to see whether the draft has unpublished changes.

      • docVersioninteger

        Send it back with each save, so a save never overwrites changes you haven't seen.

  • 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 content:unpublish, 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 content item, 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.

  • 409ConflictIt isn't published, is scheduled, or is in a release.
    • 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/environments/6650f1c2a9e4b1d2c3f40a13/regions/6650f1c2a9e4b1d2c3f40a17/locales/6650f1c2a9e4b1d2c3f40a18/content/6650f1c2a9e4b1d2c3f40a21/unpublish' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"redirectTo":"/trips"}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f40a21",    "name": "Lofoten sea kayaking",    "slug": "lofoten-sea-kayaking",    "url": "/trips/lofoten-sea-kayaking",    "status": "draft",    "contentTypeKey": "trip",    "folderId": "6650f1c2a9e4b1d2c3f40a20",    "externalId": null,    "isGlobal": false,    "isFolderIndex": false,    "updatedAt": "2026-11-02T09:30:00.000Z",    "publishedAt": "2026-11-02T09:30:00.000Z",    "urlOverride": null,    "draft": {      "fields": {},      "components": [        {          "id": "hero-1",          "type": "hero",          "schemaVersion": 12,          "fields": {            "heading": "Paddle the Lofoten fjords"          },          "children": {},          "variant": null        }      ],      "seo": {        "title": "Lofoten sea kayaking",        "description": "Six days of paddling between the peaks of Lofoten.",        "canonical": null,        "noIndex": false,        "ogTitle": null,        "ogDescription": null,        "ogImage": null,        "twitterTitle": null,        "twitterDescription": null,        "twitterImage": null,        "noFollow": false,        "breadcrumbLabel": null,        "sitemapExclude": false,        "sitemapChangeFrequency": "always",        "sitemapPriority": 0      },      "updatedAt": "2026-11-02T09:30:00.000Z",      "updatedBy": "6650f1c2a9e4b1d2c3f40a30"    },    "draftVersion": 12,    "publishedVersion": 12,    "docVersion": 12  }}

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.

Block

One block in a page body.

  • idstring

  • typestring

    The component's key, such as hero.

  • schemaVersioninteger

  • fieldsmap of any

    The component's fields.

  • childrenmap of Block[]

    Further blocks by slot.

    Fields of children
    • idstring

    • typestring

      The component's key, such as hero.

    • schemaVersioninteger

    • fieldsmap of any

      The component's fields.

    • childrenmap of Block[]

      Further blocks by slot.

      Fields of children
      • idstring

      • typestring

        The component's key, such as hero.

      • schemaVersioninteger

      • fieldsmap of any

        The component's fields.

      • childrenmap of Block[]

        Further blocks by slot.

        Fields of children
        • idstring

        • typestring

          The component's key, such as hero.

        • schemaVersioninteger

        • fieldsmap of any

          The component's fields.

        • childrenmap of Block[]

          Further blocks by slot.

        • variantstring or null

      • variantstring or null

    • variantstring or null

  • variantstring or null

Content

One piece of content with its draft.

  • idstring

    An id.

  • namestring

  • slugstring

  • urlstring or null

  • statusstring

    One of draft, in_review, published, scheduled, archived.
  • contentTypeKeystring

  • folderIdstring or null

    An id.

  • externalIdstring or null

  • isGlobalboolean

  • isFolderIndexboolean

  • updatedAtstring

  • publishedAtstring or null

  • urlOverridestring or null

  • draftobject

    The draft. No seo for content without an address.

    Fields of draft
    • fieldsmap of any

      Field values by key. See https://docs.bifrostorbit.com/cms/developers/field-types/.

    • componentsBlock[]

      Fields of Block

    • seoobjectsometimes

      Fields of seo
      • titlestring or null

      • descriptionstring or null

      • canonicalstring or null

      • noIndexboolean

      • ogTitlestring or null

      • ogDescriptionstring or null

      • ogImagestring or null

        A media id or address.

      • twitterTitlestring or null

      • twitterDescriptionstring or null

      • twitterImagestring or null

      • noFollowboolean

      • breadcrumbLabelstring or null

      • sitemapExcludeboolean

      • sitemapChangeFrequencystring or null

        One of always, hourly, daily, weekly, monthly, yearly, never.
      • sitemapPrioritynumber or null

        At least 0. At most 1.
    • updatedAtstring

    • updatedBystring

      An id.

  • draftVersioninteger

  • publishedVersioninteger

    Compare with draftVersion to see whether the draft has unpublished changes.

  • docVersioninteger

    Send it back with each save, so a save never overwrites changes you haven't seen.

Schedule

  • releaseIdstring

    The release it's in.

  • actionstring

    One of publish, unpublish.
  • atstring

  • sharedWithinteger

    Other pages in the same release.