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.

destinationone ofRequired

or

or

or

The SiteRedirect object

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

List all site redirects

get

Authorizations

user

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

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

searchstringOptional

Search for a redirect by path

draftbooleanOptional

Filter redirects by draft mode.

Default: false

Responses

200

The list of redirects for the site.

application/json

get

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

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/redirects HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The list of redirects for the site.

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "site-redirect",
      "id": "text",
      "source": "text",
      "draft": true,
      "captureWildcard": true,
      "destination": {
        "kind": "site-section",
        "siteSectionId": "text"
      }
    }
  ]
}

Create a site redirect

post

Authorizations

user

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

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"
  }
}

Create or update site redirects in bulk

put

Authorizations

user

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

Responses

200

List of results for each redirect processed.

application/json

put

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

HTTPcURLJavaScriptPython

PUT /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: 52

{
  "redirects": [
    {
      "source": "text",
      "intent": "publish"
    }
  ]
}

200

List of results for each redirect processed.

{
  "results": [
    {
      "status": "created",
      "source": "text",
      "draft": true,
      "id": "text"
    }
  ]
}

Delete a site redirect

delete

Authorizations

user

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

siteRedirectIdstringRequired

The unique id of the site redirect

Responses

204

Site redirect did not exist

No content

205

Site redirect deleted

delete

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

HTTPcURLJavaScriptPython

DELETE /v1/orgs/{organizationId}/sites/{siteId}/redirects/{siteRedirectId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update a site redirect

patch

Authorizations

user

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

siteRedirectIdstringRequired

The unique id of the site redirect

Body

application/json

sourcestring · max: 512Optional

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.

draftbooleanOptional

When true, it can be used to promote a draft redirect to live.

destinationone ofOptional

or

or

or

Responses

200

OK

application/json

patch

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

HTTPcURLJavaScriptPython

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

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

200

OK

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

Get a site redirect by its source

get

Authorizations

user

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

Query parameters

shareKeystringOptional

For sites published via share-links, the share key is useful to resolve published URLs.

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

Responses

200

The redirect was resolved successfully.

application/json

404

Not Found

application/json

get

/orgs/{organizationId}/sites/{siteId}/redirect

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/redirect?source=text HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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