Redirects
Redirects in the management API. 6 endpoints.
Read the guideOpenAPI 3.1 document
Try it settings
https://api.bifrostorbit.com/cms/manage/v1
The management API takes a management token, which is secret and acts as a person, so nothing here is sent from the docs.
Try it sends each request straight from your browser to the API. The key stays in this page's memory: it is never saved, never sent to docs.bifrostorbit.com and gone when you leave or reload the page. Only reads are run; anything that changes data is described and never sent.
The environment's redirects
GET/organisations/{organisationId}/spaces/{spaceId}/redirectsKey required
The environment's redirects. environmentId is required. Permission: redirect: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 redirects.dataRedirect[]Fields of data
_idstringAn id.
organisationIdstringAn id.
spaceIdstringAn id.
environmentIdstringAn id.
regionIdstring or nullAn id.
localeIdstring or nullAn id.
sourcestringSuch as /trips/lofoten.
One of url, content.destinationTypestringdestinationUrlstring or nulldestinationContentIdstring or nullAn id.
One of 301, 302, 307, 308.statusCodeintegerenabledboolean
One of manual, auto_url_change, import.originstringnotestring or nullnoteWordingany or any or nullsometimesThe note as a translation key, for notes CMS Orbit wrote itself.
hitsintegerlastHitAtstring or null
One of draft, published.statusstringcreatedBystringAn id.
updatedBystringAn id.
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 redirect: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/redirects?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": "6650f1c2a9e4b1d2c3f40a48", "organisationId": "6650f1c2a9e4b1d2c3f40a01", "spaceId": "6650f1c2a9e4b1d2c3f40a02", "environmentId": "6650f1c2a9e4b1d2c3f40a13", "regionId": "6650f1c2a9e4b1d2c3f40a17", "localeId": "6650f1c2a9e4b1d2c3f40a18", "source": "/trips/lofoten", "destinationType": "url", "destinationUrl": "/trips/lofoten-sea-kayaking", "destinationContentId": null, "statusCode": 301, "enabled": true, "origin": "manual", "note": null, "noteWording": null, "hits": 1, "lastHitAt": "2026-11-02T09:30:00.000Z", "status": "draft", "createdBy": "6650f1c2a9e4b1d2c3f40a30", "updatedBy": "6650f1c2a9e4b1d2c3f40a30", "createdAt": "2026-11-02T09:30:00.000Z", "updatedAt": "2026-11-02T09:30:00.000Z" } ]}Adds a redirect
POST/organisations/{organisationId}/spaces/{spaceId}/redirectsKey required
Adds a redirect. Permission: redirect: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
environmentIdstringrequiredAn id.
sourcestringrequiredThe old address, such as /trips/lofoten.
destinationUrlstringrequiredA path such as /trips/lofoten-sea-kayaking, or a full https:// address.
regionIdstring or nulloptionalAn id.
localeIdstring or nulloptionalAn id.
One of 301, 302, 307, 308. Default 301.statusCodenumberoptional
Default true.enabledbooleanoptionalnotestring or nulloptionalUp to 500 characters.
Default null. Up to 500 characters.
Responses
201CreatedThe new item.dataRedirectFields of data
_idstringAn id.
organisationIdstringAn id.
spaceIdstringAn id.
environmentIdstringAn id.
regionIdstring or nullAn id.
localeIdstring or nullAn id.
sourcestringSuch as /trips/lofoten.
One of url, content.destinationTypestringdestinationUrlstring or nulldestinationContentIdstring or nullAn id.
One of 301, 302, 307, 308.statusCodeintegerenabledboolean
One of manual, auto_url_change, import.originstringnotestring or nullnoteWordingany or any or nullsometimesThe note as a translation key, for notes CMS Orbit wrote itself.
hitsintegerlastHitAtstring or null
One of draft, published.statusstringcreatedBystringAn id.
updatedBystringAn id.
createdAtstringupdatedAtstring
400Bad requestThe body isn't valid JSON. Or a redirect to itself, in a loop, or in a chain of more than 10.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 redirect: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 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.
409ConflictA redirect from the source exists.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/redirects' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"environmentId":"6650f1c2a9e4b1d2c3f40a13","source":"/trips/lofoten","destinationUrl":"/trips/lofoten-sea-kayaking","statusCode":301}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "_id": "6650f1c2a9e4b1d2c3f40a48", "organisationId": "6650f1c2a9e4b1d2c3f40a01", "spaceId": "6650f1c2a9e4b1d2c3f40a02", "environmentId": "6650f1c2a9e4b1d2c3f40a13", "regionId": "6650f1c2a9e4b1d2c3f40a17", "localeId": "6650f1c2a9e4b1d2c3f40a18", "source": "/trips/lofoten", "destinationType": "url", "destinationUrl": "/trips/lofoten-sea-kayaking", "destinationContentId": null, "statusCode": 301, "enabled": true, "origin": "manual", "note": null, "noteWording": null, "hits": 1, "lastHitAt": "2026-11-02T09:30:00.000Z", "status": "draft", "createdBy": "6650f1c2a9e4b1d2c3f40a30", "updatedBy": "6650f1c2a9e4b1d2c3f40a30", "createdAt": "2026-11-02T09:30:00.000Z", "updatedAt": "2026-11-02T09:30:00.000Z" }}Downloads them as CSV
GET/organisations/{organisationId}/spaces/{spaceId}/redirects/exportKey required
Downloads them as CSV. Permission: redirect:read.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
environmentIdstringquery, requiredThe environment's id. Required.
Responses
200OKThe columns source, destination, status, region, locale, enabled and note.text/csv
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 redirect: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/redirects/export?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.
Adds or updates them from CSV
POST/organisations/{organisationId}/spaces/{spaceId}/redirects/importKey required
Adds or updates them from CSV. Permission: redirect: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.
csvstringrequiredThe file's text. The first row names the columns: source (or from, old url), destination (or to, new url), and optionally status, region, locale, enabled and note. Up to 5,000 rows.
applybooleanoptionalfalse (the default) only reports what would happen. true does it.
Responses
200OKWhat was or would be done.dataobjectFields of data
appliedbooleanrowsobject[]Fields of rows
lineintegersourcestringdestinationstringstatusCodeinteger or nullregionstring or null
One of create, update, unchanged, error.outcomestringmessagestring or null
countsobjectFields of counts
createintegerupdateintegerunchangedintegererrorinteger
400Bad requestThe body isn't valid JSON. Or no rows, more than 5,000, or no source and destination columns.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 redirect: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 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 -X POST 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/redirects/import' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"environmentId":"6650f1c2a9e4b1d2c3f40a13","csv":"source,destination,status\n/trips/lofoten,/trips/lofoten-sea-kayaking,301","apply":false}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "applied": false, "rows": [ { "line": 1, "source": "…", "destination": "…", "statusCode": 1, "region": null, "outcome": "create", "message": null } ], "counts": { "create": 1, "update": 1, "unchanged": 1, "error": 1 } }}Deletes one
DELETE/organisations/{organisationId}/spaces/{spaceId}/redirects/{redirectId}Key required
Deletes one. Permission: redirect:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
redirectIdstringpath, requiredThe redirect'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 redirect: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 redirect, 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 -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/spaces/6650f1c2a9e4b1d2c3f40a02/redirects/6650f1c2a9e4b1d2c3f40a30' \ -H 'Authorization: Bearer cms_mt_…'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Changes one
PATCH/organisations/{organisationId}/spaces/{spaceId}/redirects/{redirectId}Key required
Changes one. Permission: redirect:manage.
Parameters
organisationIdstringpath, requiredThe organisation's id, from the Management tokens page.
spaceIdstringpath, requiredThe space's id.
redirectIdstringpath, requiredThe redirect'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
sourcestringoptionaldestinationUrlstringoptionalregionIdstring or nulloptionalAn id.
localeIdstring or nulloptionalAn id.
One of 301, 302, 307, 308.statusCodenumberoptionalenabledbooleanoptional
Up to 500 characters.notestring or nulloptional
Responses
200OKThe redirect.dataRedirectFields of data
_idstringAn id.
organisationIdstringAn id.
spaceIdstringAn id.
environmentIdstringAn id.
regionIdstring or nullAn id.
localeIdstring or nullAn id.
sourcestringSuch as /trips/lofoten.
One of url, content.destinationTypestringdestinationUrlstring or nulldestinationContentIdstring or nullAn id.
One of 301, 302, 307, 308.statusCodeintegerenabledboolean
One of manual, auto_url_change, import.originstringnotestring or nullnoteWordingany or any or nullsometimesThe note as a translation key, for notes CMS Orbit wrote itself.
hitsintegerlastHitAtstring or null
One of draft, published.statusstringcreatedBystringAn id.
updatedBystringAn id.
createdAtstringupdatedAtstring
400Bad requestThe body isn't valid JSON. Or a redirect to itself, in a loop, or in a chain of more than 10.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 redirect: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 redirect, 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.
409ConflictA redirect from the source exists.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/redirects/6650f1c2a9e4b1d2c3f40a30' \ -H 'Authorization: Bearer cms_mt_…' \ -H 'Content-Type: application/json' \ -d '{"destinationUrl":"/trips/norway/lofoten-sea-kayaking","enabled":true}'Try it
Management tokens are secret and act as a person, so nothing is sent from the docs.
Example answer
{ "data": { "_id": "6650f1c2a9e4b1d2c3f40a48", "organisationId": "6650f1c2a9e4b1d2c3f40a01", "spaceId": "6650f1c2a9e4b1d2c3f40a02", "environmentId": "6650f1c2a9e4b1d2c3f40a13", "regionId": "6650f1c2a9e4b1d2c3f40a17", "localeId": "6650f1c2a9e4b1d2c3f40a18", "source": "/trips/lofoten", "destinationType": "url", "destinationUrl": "/trips/lofoten-sea-kayaking", "destinationContentId": null, "statusCode": 301, "enabled": true, "origin": "manual", "note": null, "noteWording": null, "hits": 1, "lastHitAt": "2026-11-02T09:30:00.000Z", "status": "draft", "createdBy": "6650f1c2a9e4b1d2c3f40a30", "updatedBy": "6650f1c2a9e4b1d2c3f40a30", "createdAt": "2026-11-02T09:30:00.000Z", "updatedAt": "2026-11-02T09:30:00.000Z" }}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.
Redirect
_idstringAn id.
organisationIdstringAn id.
spaceIdstringAn id.
environmentIdstringAn id.
regionIdstring or nullAn id.
localeIdstring or nullAn id.
sourcestringSuch as /trips/lofoten.
One of url, content.destinationTypestringdestinationUrlstring or nulldestinationContentIdstring or nullAn id.
One of 301, 302, 307, 308.statusCodeintegerenabledboolean
One of manual, auto_url_change, import.originstringnotestring or nullnoteWordingany or any or nullsometimesThe note as a translation key, for notes CMS Orbit wrote itself.
hitsintegerlastHitAtstring or null
One of draft, published.statusstringcreatedBystringAn id.
updatedBystringAn id.
createdAtstringupdatedAtstring