Skip to content

Releases

Releases 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.

The environment's releases, newest first

GET/organisations/{organisationId}/spaces/{spaceId}/releasesKey required

The environment's releases, newest first. environmentId is required. Permission: release:read.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • environmentIdstringquery, required

    The environment's id. Required.

Responses

  • 200OKList of releases.
    • dataRelease[]

      Newest first.

      Fields of data
      • _idstring

        An id.

      • organisationIdstring

        An id.

      • spaceIdstring

        An id.

      • environmentIdstring

        An id.

      • targetEnvironmentIdstring

        An id.

      • namestring

      • descriptionstring or null

      • statusstring

        One of open, scheduled, publishing, published, failed, cancelled.
      • itemsobject[]

        Fields of items
        • contentIdstring

          An id.

        • actionstringsometimes

          One of publish, unpublish.
        • regionIdstring

          An id.

        • localeIdstring

          An id.

        • includeChildrenboolean

        • addedAtstring

        • addedBystring

          An id.

        • outcomeobjectsometimes

          Fields of outcome
          • statusstring

            One of published, unpublished, failed.
          • reasonstring or null

      • scheduledAtstring or null

      • publishedAtstring or null

      • publishedBystring or null

        An id.

      • createdBystring

        An id.

      • heldByPausebooleansometimes

        Held because the organisation's plan is paused.

      • createdAtstring

      • updatedAtstring

  • 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 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/releases?environmentId=6650f1c2a9e4b1d2c3f40a13' \  -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": "6650f1c2a9e4b1d2c3f40a47",      "organisationId": "6650f1c2a9e4b1d2c3f40a01",      "spaceId": "6650f1c2a9e4b1d2c3f40a02",      "environmentId": "6650f1c2a9e4b1d2c3f40a13",      "targetEnvironmentId": "6650f1c2a9e4b1d2c3f40a63",      "name": "Winter 2026 trips",      "description": "Six days of paddling between the peaks of Lofoten.",      "status": "scheduled",      "items": [        {          "contentId": "6650f1c2a9e4b1d2c3f40a21",          "action": "publish",          "regionId": "6650f1c2a9e4b1d2c3f40a17",          "localeId": "6650f1c2a9e4b1d2c3f40a18",          "includeChildren": false,          "addedAt": "2026-11-02T09:30:00.000Z",          "addedBy": "6650f1c2a9e4b1d2c3f40a30",          "outcome": {            "status": "published",            "reason": null          }        }      ],      "scheduledAt": "2026-11-02T09:30:00.000Z",      "publishedAt": "2026-11-02T09:30:00.000Z",      "publishedBy": "6650f1c2a9e4b1d2c3f40a30",      "createdBy": "6650f1c2a9e4b1d2c3f40a30",      "heldByPause": false,      "createdAt": "2026-11-02T09:30:00.000Z",      "updatedAt": "2026-11-02T09:30:00.000Z"    }  ]}

Creates a release

POST/organisations/{organisationId}/spaces/{spaceId}/releasesKey required

Creates a release. Permission: release: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

  • environmentIdstringrequired

    The environment's id, as text.

  • namestringrequired

  • descriptionstring or nulloptional

    Up to 2000 characters.
  • scheduledAtstring or nulloptional

    When to publish it, ISO 8601 in the future. Leave it out to publish by hand.

Responses

  • 201CreatedThe release.
    • dataRelease

      Fields of data
      • _idstring

        An id.

      • organisationIdstring

        An id.

      • spaceIdstring

        An id.

      • environmentIdstring

        An id.

      • targetEnvironmentIdstring

        An id.

      • namestring

      • descriptionstring or null

      • statusstring

        One of open, scheduled, publishing, published, failed, cancelled.
      • itemsobject[]

        Fields of items
        • contentIdstring

          An id.

        • actionstringsometimes

          One of publish, unpublish.
        • regionIdstring

          An id.

        • localeIdstring

          An id.

        • includeChildrenboolean

        • addedAtstring

        • addedBystring

          An id.

        • outcomeobjectsometimes

          Fields of outcome
          • statusstring

            One of published, unpublished, failed.
          • reasonstring or null

      • scheduledAtstring or null

      • publishedAtstring or null

      • publishedBystring or null

        An id.

      • createdBystring

        An id.

      • heldByPausebooleansometimes

        Held because the organisation's plan is paused.

      • createdAtstring

      • updatedAtstring

  • 400Bad requestThe body isn't valid JSON. Or an empty name, or a scheduledAt that isn't a date or is 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 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 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/releases' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"environmentId":"6650f1c2a9e4b1d2c3f40a13","name":"Winter 2026 trips","scheduledAt":"2026-12-01T08:00:00Z"}'

Try it

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

Example answer

201 CreatedJSON
{  "data": {    "_id": "6650f1c2a9e4b1d2c3f40a47",    "organisationId": "6650f1c2a9e4b1d2c3f40a01",    "spaceId": "6650f1c2a9e4b1d2c3f40a02",    "environmentId": "6650f1c2a9e4b1d2c3f40a13",    "targetEnvironmentId": "6650f1c2a9e4b1d2c3f40a63",    "name": "Winter 2026 trips",    "description": "Six days of paddling between the peaks of Lofoten.",    "status": "scheduled",    "items": [      {        "contentId": "6650f1c2a9e4b1d2c3f40a21",        "action": "publish",        "regionId": "6650f1c2a9e4b1d2c3f40a17",        "localeId": "6650f1c2a9e4b1d2c3f40a18",        "includeChildren": false,        "addedAt": "2026-11-02T09:30:00.000Z",        "addedBy": "6650f1c2a9e4b1d2c3f40a30",        "outcome": {          "status": "published",          "reason": null        }      }    ],    "scheduledAt": "2026-11-02T09:30:00.000Z",    "publishedAt": "2026-11-02T09:30:00.000Z",    "publishedBy": "6650f1c2a9e4b1d2c3f40a30",    "createdBy": "6650f1c2a9e4b1d2c3f40a30",    "heldByPause": false,    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z"  }}

Deletes it

DELETE/organisations/{organisationId}/spaces/{spaceId}/releases/{releaseId}Key required

Deletes it. Permission: release:delete.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • releaseIdstringpath, required

    The release'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 release: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 release, 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.

  • 409ConflictOnly open or scheduled releases can change.
    • 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/releases/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 or reschedules it

PATCH/organisations/{organisationId}/spaces/{spaceId}/releases/{releaseId}Key required

Renames or reschedules it. scheduledAt: null unschedules it. Permission: release:manage.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • releaseIdstringpath, required

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

  • namestringoptional

  • scheduledAtstring or nulloptional

    A new time, or null to unschedule it.

Responses

  • 200OKThe release.
    • dataRelease

      Fields of data
      • _idstring

        An id.

      • organisationIdstring

        An id.

      • spaceIdstring

        An id.

      • environmentIdstring

        An id.

      • targetEnvironmentIdstring

        An id.

      • namestring

      • descriptionstring or null

      • statusstring

        One of open, scheduled, publishing, published, failed, cancelled.
      • itemsobject[]

        Fields of items
        • contentIdstring

          An id.

        • actionstringsometimes

          One of publish, unpublish.
        • regionIdstring

          An id.

        • localeIdstring

          An id.

        • includeChildrenboolean

        • addedAtstring

        • addedBystring

          An id.

        • outcomeobjectsometimes

          Fields of outcome
          • statusstring

            One of published, unpublished, failed.
          • reasonstring or null

      • scheduledAtstring or null

      • publishedAtstring or null

      • publishedBystring or null

        An id.

      • createdBystring

        An id.

      • heldByPausebooleansometimes

        Held because the organisation's plan is paused.

      • createdAtstring

      • updatedAtstring

  • 400Bad requestThe body isn't valid JSON. Or an empty name, or a scheduledAt that isn't a date or is 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 release: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 release, 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.

  • 409ConflictOnly open or scheduled releases can change.
    • 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/releases/6650f1c2a9e4b1d2c3f40a30' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"scheduledAt":"2026-12-02T08:00:00Z"}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "_id": "6650f1c2a9e4b1d2c3f40a47",    "organisationId": "6650f1c2a9e4b1d2c3f40a01",    "spaceId": "6650f1c2a9e4b1d2c3f40a02",    "environmentId": "6650f1c2a9e4b1d2c3f40a13",    "targetEnvironmentId": "6650f1c2a9e4b1d2c3f40a63",    "name": "Winter 2026 trips",    "description": "Six days of paddling between the peaks of Lofoten.",    "status": "scheduled",    "items": [      {        "contentId": "6650f1c2a9e4b1d2c3f40a21",        "action": "publish",        "regionId": "6650f1c2a9e4b1d2c3f40a17",        "localeId": "6650f1c2a9e4b1d2c3f40a18",        "includeChildren": false,        "addedAt": "2026-11-02T09:30:00.000Z",        "addedBy": "6650f1c2a9e4b1d2c3f40a30",        "outcome": {          "status": "published",          "reason": null        }      }    ],    "scheduledAt": "2026-11-02T09:30:00.000Z",    "publishedAt": "2026-11-02T09:30:00.000Z",    "publishedBy": "6650f1c2a9e4b1d2c3f40a30",    "createdBy": "6650f1c2a9e4b1d2c3f40a30",    "heldByPause": false,    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z"  }}

Cancels it

POST/organisations/{organisationId}/spaces/{spaceId}/releases/{releaseId}/cancelKey required

Cancels it. Permission: release:manage.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • releaseIdstringpath, required

    The release'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 release: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 release, 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.

  • 409ConflictOnly open or scheduled releases can change.
    • 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/releases/6650f1c2a9e4b1d2c3f40a30/cancel' \  -H 'Authorization: Bearer cms_mt_…'

Try it

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

Takes a page out

DELETE/organisations/{organisationId}/spaces/{spaceId}/releases/{releaseId}/items/{contentId}Key required

Takes a page out. Permission: release:manage.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • releaseIdstringpath, required

    The release's id.

  • contentIdstringpath, required

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

  • 409ConflictOnly open or scheduled releases can change.
    • 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/releases/6650f1c2a9e4b1d2c3f40a30/items/6650f1c2a9e4b1d2c3f40a21' \  -H 'Authorization: Bearer cms_mt_…'

Try it

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

Adds a page, or changes what happens to it: { "action": "publish" } or "unpublish"

PUT/organisations/{organisationId}/spaces/{spaceId}/releases/{releaseId}/items/{contentId}Key required

Adds a page, or changes what happens to it: { "action": "publish" } or "unpublish". Permission: release:manage.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • releaseIdstringpath, required

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

  • actionstringoptional

    Anything but unpublish counts as publish.

    One of publish, unpublish.

Responses

  • 200OKThe release.
    • dataRelease

      Fields of data
      • _idstring

        An id.

      • organisationIdstring

        An id.

      • spaceIdstring

        An id.

      • environmentIdstring

        An id.

      • targetEnvironmentIdstring

        An id.

      • namestring

      • descriptionstring or null

      • statusstring

        One of open, scheduled, publishing, published, failed, cancelled.
      • itemsobject[]

        Fields of items
        • contentIdstring

          An id.

        • actionstringsometimes

          One of publish, unpublish.
        • regionIdstring

          An id.

        • localeIdstring

          An id.

        • includeChildrenboolean

        • addedAtstring

        • addedBystring

          An id.

        • outcomeobjectsometimes

          Fields of outcome
          • statusstring

            One of published, unpublished, failed.
          • reasonstring or null

      • scheduledAtstring or null

      • publishedAtstring or null

      • publishedBystring or null

        An id.

      • createdBystring

        An id.

      • heldByPausebooleansometimes

        Held because the organisation's plan is paused.

      • createdAtstring

      • updatedAtstring

  • 400Bad requestThe body isn't valid JSON. Or unpublishing a page that isn't published.
    • 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: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 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.

  • 409ConflictOnly open or scheduled releases can change.
    • 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 PUT 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/releases/6650f1c2a9e4b1d2c3f40a30/items/6650f1c2a9e4b1d2c3f40a21' \  -H 'Authorization: Bearer cms_mt_…' \  -H 'Content-Type: application/json' \  -d '{"action":"publish"}'

Try it

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

Example answer

200 OKJSON
{  "data": {    "_id": "6650f1c2a9e4b1d2c3f40a47",    "organisationId": "6650f1c2a9e4b1d2c3f40a01",    "spaceId": "6650f1c2a9e4b1d2c3f40a02",    "environmentId": "6650f1c2a9e4b1d2c3f40a13",    "targetEnvironmentId": "6650f1c2a9e4b1d2c3f40a63",    "name": "Winter 2026 trips",    "description": "Six days of paddling between the peaks of Lofoten.",    "status": "scheduled",    "items": [      {        "contentId": "6650f1c2a9e4b1d2c3f40a21",        "action": "publish",        "regionId": "6650f1c2a9e4b1d2c3f40a17",        "localeId": "6650f1c2a9e4b1d2c3f40a18",        "includeChildren": false,        "addedAt": "2026-11-02T09:30:00.000Z",        "addedBy": "6650f1c2a9e4b1d2c3f40a30",        "outcome": {          "status": "published",          "reason": null        }      }    ],    "scheduledAt": "2026-11-02T09:30:00.000Z",    "publishedAt": "2026-11-02T09:30:00.000Z",    "publishedBy": "6650f1c2a9e4b1d2c3f40a30",    "createdBy": "6650f1c2a9e4b1d2c3f40a30",    "heldByPause": false,    "createdAt": "2026-11-02T09:30:00.000Z",    "updatedAt": "2026-11-02T09:30:00.000Z"  }}

Publishes it now

POST/organisations/{organisationId}/spaces/{spaceId}/releases/{releaseId}/publishKey required

Publishes it now. Permission: release:publish.

Parameters

  • organisationIdstringpath, required

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

  • spaceIdstringpath, required

    The space's id.

  • releaseIdstringpath, required

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

  • 200OK{ release, outcome: { published, unpublished, failed } }.
    • dataobject

      Fields of data
      • releaseRelease

        Fields of Release

      • outcomeobject

        Fields of outcome
        • publishedstring[]

          Pages published.

        • unpublishedstring[]

          Pages taken off the website.

        • failedobject[]

          Fields of failed
          • contentIdstring

            An id.

          • reasonstring

  • 400Bad requestThe release is empty.
    • 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: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 release, 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 open or scheduled, or it's being published already.
    • 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/releases/6650f1c2a9e4b1d2c3f40a30/publish' \  -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": {    "release": {      "_id": "6650f1c2a9e4b1d2c3f40a40",      "organisationId": "6650f1c2a9e4b1d2c3f40a01",      "spaceId": "6650f1c2a9e4b1d2c3f40a02",      "environmentId": "6650f1c2a9e4b1d2c3f40a13",      "targetEnvironmentId": "6650f1c2a9e4b1d2c3f40a63",      "name": "Lofoten sea kayaking",      "description": "Six days of paddling between the peaks of Lofoten.",      "status": "open",      "items": [        {          "contentId": "6650f1c2a9e4b1d2c3f40a21",          "action": "publish",          "regionId": "6650f1c2a9e4b1d2c3f40a17",          "localeId": "6650f1c2a9e4b1d2c3f40a18",          "includeChildren": false,          "addedAt": "2026-11-02T09:30:00.000Z",          "addedBy": "6650f1c2a9e4b1d2c3f40a30",          "outcome": {            "status": "published",            "reason": null          }        }      ],      "scheduledAt": "2026-11-02T09:30:00.000Z",      "publishedAt": "2026-11-02T09:30:00.000Z",      "publishedBy": "6650f1c2a9e4b1d2c3f40a30",      "createdBy": "6650f1c2a9e4b1d2c3f40a30",      "heldByPause": false,      "createdAt": "2026-11-02T09:30:00.000Z",      "updatedAt": "2026-11-02T09:30:00.000Z"    },    "outcome": {      "published": [        "…"      ],      "unpublished": [        "…"      ],      "failed": [        {          "contentId": "6650f1c2a9e4b1d2c3f40a21",          "reason": "…"        }      ]    }  }}

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.

Release

  • _idstring

    An id.

  • organisationIdstring

    An id.

  • spaceIdstring

    An id.

  • environmentIdstring

    An id.

  • targetEnvironmentIdstring

    An id.

  • namestring

  • descriptionstring or null

  • statusstring

    One of open, scheduled, publishing, published, failed, cancelled.
  • itemsobject[]

    Fields of items
    • contentIdstring

      An id.

    • actionstringsometimes

      One of publish, unpublish.
    • regionIdstring

      An id.

    • localeIdstring

      An id.

    • includeChildrenboolean

    • addedAtstring

    • addedBystring

      An id.

    • outcomeobjectsometimes

      Fields of outcome
      • statusstring

        One of published, unpublished, failed.
      • reasonstring or null

  • scheduledAtstring or null

  • publishedAtstring or null

  • publishedBystring or null

    An id.

  • createdBystring

    An id.

  • heldByPausebooleansometimes

    Held because the organisation's plan is paused.

  • createdAtstring

  • updatedAtstring