URL Redirects

Basic Redirect

Redirect an old URL to a new one:

{
  "redirects": [
    {
      "source": "/old-path",
      "destination": "/new-path",
      "permanent": true
    }
  ]
}

Temporary Redirects

Use temporary redirects for non-permanent changes:

{
  "redirects": [
    {
      "source": "/beta-feature",
      "destination": "/features/new-feature",
      "permanent": false
    }
  ]
}

Multiple Redirects

Set up multiple redirect rules:

{
  "redirects": [
    {
      "source": "/old-docs",
      "destination": "/documentation",
      "permanent": true
    },
    {
      "source": "/guide",
      "destination": "/guides/getting-started",
      "permanent": true
    },
    {
      "source": "/v1/api",
      "destination": "/api/v2",
      "permanent": false
    }
  ]
}

Redirect Options

source

string

required

The old URL path to redirect from

destination

string

required

The new URL path to redirect to

permanent

boolean

required

Whether the redirect is permanent (301) or temporary (302)

When to Use

Renaming pages

When you rename a page, add a redirect from the old URL to prevent broken links.

Restructuring docs

If you reorganize your navigation, redirect old paths to their new locations.

Version migrations

When updating API versions, redirect old version URLs to new ones.

Permanent vs Temporary

Permanent (301): Page moved permanently, update bookmarks
Temporary (302): Page temporarily relocated, keep old URL

Redirects help maintain SEO and prevent broken links when restructuring your documentation.