Site redirects

Establish redirects for pages that have moved or changed in your docs site.

Keep your site's content fresh without breaking old links. This API allows you to create and manage redirection rules.

The SiteRedirect object

Attributes

objectstring · enumRequiredPossible values:

idstringRequired

The unique identifier for the redirect.

sourcestring · max: 512Required

The source path to redirect from.

Pattern: ^\/(?!\*)(?!.*\*.+)(?:[A-Za-z0-9\-._~+]|%[0-9A-Fa-f]{2})+(?:\/(?:[A-Za-z0-9\-._~+]|%[0-9A-Fa-f]{2})+)*(?:\/\*|\*)?$

draftbooleanRequired

Whether the redirect is draft and not live.

captureWildcardbooleanRequired

Capture and append the wildcard-matched suffix to the destination URL.

permanentbooleanRequired

Whether the redirect is configured as permanent. Permanent redirects are served as HTTP 308 for public live traffic and HTTP 307 in non-public contexts.

destinationone ofRequired

or

or

or

createdAtstring · date-timeRequired

When the redirect was created.

updatedAtstring · date-timeOptional

When the redirect was last updated. Absent if never updated since creation.

The SiteRedirect object

{
  "object": "site-redirect",
  "id": "text",
  "source": "text",
  "draft": true,
  "captureWildcard": true,
  "permanent": true,
  "destination": {
    "kind": "site-section",
    "siteSectionId": "text"
  },
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}