Redirects

Manage URL redirects and path rewrites for your Stormkit environments

The Redirects API allows you to configure URL redirects and path rewrites at the environment level.

Get Redirects

GET /v1/redirects · endpoint

Retrieve all redirect rules for an environment.

Response

redirects · array

Array of redirect objects

Show Redirect Object

from · string

Source path or pattern (supports wildcards)

to · string

Destination path or URL

status · number

HTTP status code (200, 301, or 302)

assets · boolean

Whether to include assets in wildcard redirects

hosts · array

Array of hostnames to apply this redirect to

Request

curl -X GET \
  -H 'Authorization: <api_key>' \
  -H 'Content-Type: application/json' \
  'https://api.stormkit.io/v1/redirects'

---

Set Redirects

POST /v1/redirects · endpoint

Update redirect rules for an environment.

This endpoint replaces all existing redirects. Include all redirect rules you want to keep.

Request Body

redirects · array · required

Array of redirect objects to set

Show Redirect Object

from · string · required

Source path or pattern. Supports wildcards (*)

to · string · required

Destination path or URL

status · number · default: "200"

HTTP status code: 200 (rewrite), 301 (permanent redirect), or 302 (temporary redirect)

assets · boolean · default: "false"

Apply wildcard redirects to asset files (files with extensions)

hosts · array

Limit redirect to specific hostnames

Response

redirects · array

The updated array of redirect objects

Request

curl -X POST \
  -H 'Authorization: <api_key>' \
  -H 'Content-Type: application/json' \
  'https://api.stormkit.io/v1/redirects' \
  -d '{
    "redirects": [
      {
        "from": "/old-path",
        "to": "/new-path",
        "status": 301
      },
      {
        "from": "*",
        "to": "index.html",
        "status": 200
      }
    ]
  }'

---

Redirect Types

Path Rewrite (Status 200)

Serve content from a different path without changing the URL:

{
  "from": "*",
  "to": "index.html",
  "status": 200
}

This is commonly used for single-page applications to handle client-side routing.

Permanent Redirect (Status 301)

Redirect permanently to a new URL:

{
  "from": "/old-page",
  "to": "/new-page",
  "status": 301
}

Use for moved content that won’t be returning to the old URL.

Temporary Redirect (Status 302)

Redirect temporarily to a different URL:

{
  "from": "/maintenance",
  "to": "/under-construction",
  "status": 302
}

Use when content is temporarily moved but will return to the original URL.

---

Advanced Patterns

Wildcard Redirects

Use * to match any path segment:

{
  "from": "/blog/*",
  "to": "/articles/*",
  "status": 301
}

This redirects /blog/my-post to /articles/my-post.

Regex Patterns

Use regex capture groups with $1, $2, etc.:

{
  "from": "/users/(.*)",
  "to": "/profile/$1",
  "status": 301
}

Host-Specific Redirects

Apply redirects only to specific domains:

{
  "from": "/",
  "to": "/landing",
  "status": 200,
  "hosts": ["example.com", "www.example.com"]
}

Domain Redirects

Redirect from one domain to another:

{
  "from": "old-domain.com",
  "to": "new-domain.com/*",
  "status": 301
}

Excluding Assets

By default, wildcard redirects exclude asset files (files with extensions). To include assets:

{
  "from": "*",
  "to": "index.html",
  "status": 200,
  "assets": true
}

Setting assets: true will apply the redirect to all files including CSS, JavaScript, and images. Use with caution.

---

Common Use Cases

Single Page Application

{
  "redirects": [
    {
      "from": "*",
      "to": "index.html",
      "status": 200
    }
  ]
}

WWW to Non-WWW

{
  "redirects": [
    {
      "from": "www.example.com",
      "to": "example.com/*",
      "status": 301
    }
  ]
}

Multiple Redirects with Priorities

{
  "redirects": [
    {
      "from": "/old-blog/*",
      "to": "/blog/*",
      "status": 301
    },
    {
      "from": "/docs/v1/*",
      "to": "/docs/latest/*",
      "status": 302
    },
    {
      "from": "*",
      "to": "index.html",
      "status": 200
    }
  ]
}

Redirects are processed in order. More specific rules should be placed before general wildcard rules.