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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringquery, requiredThe environment's id. Required.
Responses
200OKList of releases.dataRelease[]Newest first.
Fields of data
_idstringAn id.
organisationIdstringAn id.
spaceIdstringAn id.
environmentIdstringAn id.
targetEnvironmentIdstringAn id.
namestringdescriptionstring or null
One of open, scheduled, publishing, published, failed, cancelled.statusstringitemsobject[]Fields of items
contentIdstringAn id.
One of publish, unpublish.actionstringsometimesregionIdstringAn id.
localeIdstringAn id.
includeChildrenbooleanaddedAtstringaddedBystringAn id.
outcomeobjectsometimesFields of outcome
One of published, unpublished, failed.statusstringreasonstring or null
scheduledAtstring or nullpublishedAtstring or nullpublishedBystring or nullAn id.
createdBystringAn id.
heldByPausebooleansometimesHeld because the organisation's plan is paused.
createdAtstringupdatedAtstring
401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
Idempotency-KeystringheaderOptional. 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
environmentIdstringrequiredThe environment's id, as text.
namestringrequired
Up to 2000 characters.descriptionstring or nulloptionalscheduledAtstring or nulloptionalWhen to publish it, ISO 8601 in the future. Leave it out to publish by hand.
Responses
201CreatedThe release.dataReleaseFields of data
_idstringAn id.
organisationIdstringAn id.
spaceIdstringAn id.
environmentIdstringAn id.
targetEnvironmentIdstringAn id.
namestringdescriptionstring or null
One of open, scheduled, publishing, published, failed, cancelled.statusstringitemsobject[]Fields of items
contentIdstringAn id.
One of publish, unpublish.actionstringsometimesregionIdstringAn id.
localeIdstringAn id.
includeChildrenbooleanaddedAtstringaddedBystringAn id.
outcomeobjectsometimesFields of outcome
One of published, unpublished, failed.statusstringreasonstring or null
scheduledAtstring or nullpublishedAtstring or nullpublishedBystring or nullAn id.
createdBystringAn id.
heldByPausebooleansometimesHeld because the organisation's plan is paused.
createdAtstringupdatedAtstring
400Bad requestThe body isn't valid JSON. Or an empty name, or a scheduledAt that isn't a date or is in the past.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
releaseIdstringpath, requiredThe 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
releaseIdstringpath, requiredThe release's id.
Idempotency-KeystringheaderOptional. 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
namestringoptionalscheduledAtstring or nulloptionalA new time, or null to unschedule it.
Responses
200OKThe release.dataReleaseFields of data
_idstringAn id.
organisationIdstringAn id.
spaceIdstringAn id.
environmentIdstringAn id.
targetEnvironmentIdstringAn id.
namestringdescriptionstring or null
One of open, scheduled, publishing, published, failed, cancelled.statusstringitemsobject[]Fields of items
contentIdstringAn id.
One of publish, unpublish.actionstringsometimesregionIdstringAn id.
localeIdstringAn id.
includeChildrenbooleanaddedAtstringaddedBystringAn id.
outcomeobjectsometimesFields of outcome
One of published, unpublished, failed.statusstringreasonstring or null
scheduledAtstring or nullpublishedAtstring or nullpublishedBystring or nullAn id.
createdBystringAn id.
heldByPausebooleansometimesHeld because the organisation's plan is paused.
createdAtstringupdatedAtstring
400Bad requestThe body isn't valid JSON. Or an empty name, or a scheduledAt that isn't a date or is in the past.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
releaseIdstringpath, requiredThe release's id.
Idempotency-KeystringheaderOptional. 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
releaseIdstringpath, requiredThe release's id.
contentIdstringpath, requiredThe 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
releaseIdstringpath, requiredThe release's id.
contentIdstringpath, requiredThe content item's id.
Idempotency-KeystringheaderOptional. 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
actionstringoptionalAnything but unpublish counts as publish.
One of publish, unpublish.
Responses
200OKThe release.dataReleaseFields of data
_idstringAn id.
organisationIdstringAn id.
spaceIdstringAn id.
environmentIdstringAn id.
targetEnvironmentIdstringAn id.
namestringdescriptionstring or null
One of open, scheduled, publishing, published, failed, cancelled.statusstringitemsobject[]Fields of items
contentIdstringAn id.
One of publish, unpublish.actionstringsometimesregionIdstringAn id.
localeIdstringAn id.
includeChildrenbooleanaddedAtstringaddedBystringAn id.
outcomeobjectsometimesFields of outcome
One of published, unpublished, failed.statusstringreasonstring or null
scheduledAtstring or nullpublishedAtstring or nullpublishedBystring or nullAn id.
createdBystringAn id.
heldByPausebooleansometimesHeld because the organisation's plan is paused.
createdAtstringupdatedAtstring
400Bad requestThe body isn't valid JSON. Or unpublishing a page that isn't published.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
releaseIdstringpath, requiredThe release's id.
Idempotency-KeystringheaderOptional. 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 } }.dataobjectFields of data
releaseReleaseoutcomeobjectFields of outcome
publishedstring[]Pages published.
unpublishedstring[]Pages taken off the website.
failedobject[]Fields of failed
contentIdstringAn id.
reasonstring
400Bad requestThe release is empty.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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.
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
{ "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.
errorobjectFields of error
One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.codestringmessagestringFollows Accept-Language when CMS Orbit has the language.
detailsanysometimesWhen 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
_idstringAn id.
organisationIdstringAn id.
spaceIdstringAn id.
environmentIdstringAn id.
targetEnvironmentIdstringAn id.
namestringdescriptionstring or null
One of open, scheduled, publishing, published, failed, cancelled.statusstringitemsobject[]Fields of items
contentIdstringAn id.
One of publish, unpublish.actionstringsometimesregionIdstringAn id.
localeIdstringAn id.
includeChildrenbooleanaddedAtstringaddedBystringAn id.
outcomeobjectsometimesFields of outcome
One of published, unpublished, failed.statusstringreasonstring or null
scheduledAtstring or nullpublishedAtstring or nullpublishedBystring or nullAn id.
createdBystringAn id.
heldByPausebooleansometimesHeld because the organisation's plan is paused.
createdAtstringupdatedAtstring