Path: {path}
Category: {category}
Search: {Array.isArray(search) ? search.join(', ') : search}
{JSON.stringify({ params, query }, null, 2)}
)
}
})
```
`param.path(name)` is type-checked against the page route and returns one string. `param.query(name)` returns a string, an array when the key is repeated, or `undefined`. The raw `params` and `query` maps contain the same values.
Use the query-time parameter helper to bind request values into CMS queries. See [Build pages with CMS data](/docs/guides/build-pages-with-cms-data).
## Configure redirects
Add an inline `redirects` array to the `website_config` singleton. `metadata` and `redirects` can coexist:
```tsx website_config theme={null}
import { defineWebsiteConfig } from '@website'
export default defineWebsiteConfig({
metadata: {
title: 'Acme Journal',
titleTemplate: '%s | Acme Journal'
},
redirects: [
{ from: '/news', to: '/blog', status: 301 },
{ from: '/blog/:slug', to: '/articles/:slug', status: 308 },
{
from: '/help/:article',
to: 'https://support.example.com/articles/:article',
status: 302
}
]
})
```
Each rule requires exactly three fields:
| Field | Type | Behavior |
| -------- | ------ | ---------------------------------------------------------------------------------------------- |
| `from` | string | Site-relative source pattern, using the same static and `:param` segment syntax as page routes |
| `to` | string | Site-relative path or absolute `http`/`https` URL |
| `status` | number | `301`, `302`, `307`, or `308` |
Redirects run before page matching and server rendering. The first matching rule wins, so put specific rules before broader parameterized rules:
```tsx theme={null}
redirects: [
{ from: '/blog/special', to: '/featured', status: 302 },
{ from: '/blog/:slug', to: '/articles/:slug', status: 301 }
]
```
If those rules were reversed, `/blog/special` would redirect to `/articles/special`.
### Redirect status codes
| Status | Persistence | Request method behavior | Common use |
| ------ | ----------- | ------------------------------------------ | ------------------------------------------------ |
| `301` | Permanent | A client may change non-GET methods to GET | Permanent URL migration for ordinary pages |
| `302` | Temporary | A client may change non-GET methods to GET | Temporary page move |
| `307` | Temporary | Preserves the request method and body | Temporary redirect for method-sensitive requests |
| `308` | Permanent | Preserves the request method and body | Permanent method-preserving migration |
Browsers and search engines cache permanent redirects aggressively. Use `302` or `307` until you are certain a move is permanent.
### Parameters and query strings
A target can reuse any parameter declared by its source:
```tsx theme={null}
{ from: '/store/:category/:slug', to: '/shop/:category/:slug', status: 308 }
```
A target parameter that does not exist in `from` fails validation. Parameter names cannot repeat within one pattern.
Incoming query strings are always preserved and appended to the target. Do not include a query string or hash in `from` or `to`:
```text theme={null}
/news?ref=email -> /blog?ref=email
```
### Local and external targets
Local targets begin with `/`. External targets must be absolute `http` or `https` URLs without credentials, query strings, or hashes:
```tsx theme={null}
redirects: [
{ from: '/community', to: 'https://community.example.com/', status: 302 }
]
```
Protocol-relative URLs, unsafe schemes, and URLs containing a username or password are rejected.
### Validation and loop protection
`head/check` and publish reject:
* Empty paths, whitespace, repeated slashes, trailing slashes, query strings, and hashes
* Unsupported status codes
* Duplicate source patterns, including duplicates that differ only by case
* Self-redirects and local redirect loops, including loops through parameterized routes
* Target parameters absent from the source
* Redirects from reserved serving paths
* Unknown, computed, duplicate, or spread properties
The `redirects` value must be an inline array of inline object literals. Variables, function calls, object spreads, array spreads, and computed keys are not statically extractable:
```tsx theme={null}
// Invalid
const redirects = [{ from: '/old', to: '/new', status: 301 }]
export default defineWebsiteConfig({ redirects })
```
## Edit redirects through the API
There is no partial redirects endpoint. Read the current head snapshot, update the complete `website_config` source, then upsert the singleton with `PUT /v1/websiteSourceCode/files`:
```ts theme={null}
const source = `import { defineWebsiteConfig } from '@website'
export default defineWebsiteConfig({
metadata: { title: 'Acme' },
redirects: [
{ from: '/old', to: '/new', status: 308 }
]
})`
const response = await fetch(
'https://api.cactal.ai/v1/websiteSourceCode/files',
{
method: 'PUT',
headers: {
Authorization: `Bearer ${process.env.CACTAL_API_KEY}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
websiteId: 'V1StGXR8_Z5jdHi6B-myT',
file: { type: 'website_config' },
content: source,
leaseToken
})
}
)
if (!response.ok) throw new Error(`Update failed: ${response.status}`)
```