Create a URL redirect rule for a site

Creates a new redirect rule mapping a source path to a destination URL or content reference. Use the bulk upsert endpoint instead when creating many redirects at once.

Available in MCP

post

Authorizations

useroauth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

Body

application/json

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})+)*(?:\/\*|\*)?$

captureWildcardbooleanOptional

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

Default: false

draftbooleanOptional

Whether the redirect is draft and not live.

Default: false

destinationone ofRequired

or

or

or

or

Responses

201

The redirect was created successfully.

application/json

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.

destinationone ofRequired

or

or

or

post/orgs/{organizationId}/sites/{siteId}/redirects

HTTPcURLJavaScriptPython

POST /v1/orgs/{organizationId}/sites/{siteId}/redirects HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "source": "text",
  "captureWildcard": false,
  "draft": false,
  "destination": {
    "kind": "site-section",
    "siteSectionId": "text"
  }
}

201

The redirect was created successfully.

{
  "object": "site-redirect",
  "id": "text",
  "source": "text",
  "draft": true,
  "captureWildcard": true,
  "destination": {
    "kind": "site-section",
    "siteSectionId": "text"
  }
}