> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Replace a redirect

> Replaces the whole document: every field left out is reset to its default.

```ts AdonisJS wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const redirect = await site.redirects().replaceRedirect({ id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title', redirectSlug: 'example-slug' })
```

```json 200 wrap theme={"dark"}
{
  "title": "Example title",
  "redirectSlug": "example-slug",
  "urlType": "internal",
  "_newPage": [
    {}
  ],
  "externalUrl": "https://acme.example/example",
  "statusCode": "301",
  "ignoreQueryString": false,
  "forwardQueryString": false,
  "slug": "example-slug",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}
```

## In your app

A controller answers a route on your app: it calls `replaceRedirect()` and returns the answer.

**1. Add the controller**

```ts app/controllers/replace_redirect_controller.ts theme={"dark"}
import { inject } from '@adonisjs/core'
import type { HttpContext } from '@adonisjs/core/http'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class ReplaceRedirectController {
  constructor(protected site: SiteClient) {}

  async handle({ params }: HttpContext) {
    return this.site.redirects().replaceRedirect({ id: params.id, title: 'Example title', redirectSlug: 'example-slug' })
  }
}
```

The other values are the example’s: take yours from the request, a form or your database.

**2. Add the route**

```ts start/routes.ts theme={"dark"}
import router from '@adonisjs/core/services/router'

const ReplaceRedirectController = () => import('#controllers/replace_redirect_controller')

router.put('/redirect/:id', [ReplaceRedirectController])
```

Put it behind your auth middleware (`.use(middleware.auth())`): it acts with your key’s access.

**3. Call it**

Your own page’s form or script sends `PUT /redirect/clx8m2k4p0000a1b2c3d4e5f6` and gets back its answer as JSON. Test it, below, calls it.

PATCH changes only the fields sent. Update an existing redirect.

## Find the id

`id` is the document’s `_id`, from a list. Ask the list for only the fields you need: each row is a document’s `id` and those fields.

```ts AdonisJS wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const row = (await site.redirects().listRedirectsPick(['title', 'slug'])).find((each) => each.slug === 'getting-started') // { id, title, slug }, or undefined
```

Pass `row.id` as `id`. See [Find an id](https://docs.fetchski-attract.com/find-an-id.md).

> [accordion] Required parameters
>
> One object, e.g. `replaceRedirect({ id })`; leave out the optional fields.
>
> **id** `string` *required*
>
> **Required.** The document’s `_id`: a full id names its own locale and mode (the draft’s `…:en:draft`, the published one’s `…:en:published`; no `aposMode` needed), a bare `aposDocId` takes the request’s (`aposLocale`, `aposMode`).
>
> **title** `string` *required*
>
> **Required.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **redirectSlug** `string` *required*
>
> **Required.** Format with leading slash (e.g., /old-url)

> [accordion] Optional parameters
>
> **urlType** `UrlType | null | undefined`
>
> **Optional.** Leave it out and the site uses `"internal"`. Link Type. One of `internal`, `external`.
>
> **newPage** `readonly Readonly\<Record\<string, unknown\>\>[] | null | undefined`
>
> **Optional.** The related `@apostrophecms/page` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.
>
> **externalUrl** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. When set, a URL; empty or null when not.
>
> **statusCode** `StatusCode | null | undefined`
>
> **Optional.** Leave it out and the site uses `"301"`. Redirect Type. One of `302`, `301`.
>
> **ignoreQueryString** `boolean | null | undefined`
>
> **Optional.** Leave it out and the site uses `false`. Ignore query string when matching.
>
> **forwardQueryString** `boolean | null | undefined`
>
> **Optional.** Leave it out and the site uses `false`. Forward query string.
>
> **slug** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept). Left out, it’s made from the title.
>
> **archived** `boolean | null | undefined`
>
> **Optional.** Leave it out and the site uses `false`. In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document.

> [accordion] Returns
>
> A `Redirect`. Redirect content type. Read its properties (`redirect.title`): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (`_id` → `id`, `_newPage` → `newPage`).
>
> **title** `string`
>
> **Always sent.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **redirectSlug** `string`
>
> **Always sent.** Format with leading slash (e.g., /old-url)
>
> **slug** `string`
>
> **Always sent.** The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
>
> **id** `string`
>
> **Always sent.** The document’s id. On a type with drafts it ends in its locale and mode (`…:en:published`, `…:en:draft`): the part before the first colon is its `aposDocId`, shared by both copies. The `{_id}` the type’s routes take.
>
> **type** `string`
>
> **Always sent.** The document type’s name: always this type’s.
>
> **createdAt** `Date`
>
> **Always sent.** When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `Date`
>
> **Always sent.** When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **urlType** `UrlType | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Link Type. One of `internal`, `external`; a newer site may send others, so keep a fallback.
>
> **newPage** `readonly Readonly\<Record\<string, unknown\>\>[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The related `@apostrophecms/page` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.
>
> **externalUrl** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. When set, a URL; empty or null when not.
>
> **statusCode** `StatusCode | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Redirect Type. One of `302`, `301`; a newer site may send others, so keep a fallback.
>
> **ignoreQueryString** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Ignore query string when matching.
>
> **forwardQueryString** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Forward query string.
>
> **archived** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see [Map SDK errors to responses](https://docs.fetchski-attract.com/adonisjs/calling-the-api.md#map-sdk-errors-to-responses)); catch only what you want to react to here.
>
> **ValidationFailed** `400`
>
> The site refused what was sent: `errors` lists each field’s problem, `siteMessage` the first.
>
> **Retried first:** No. **Read:** `errors` (field → messages), `siteMessage`.
>
> **AuthenticationFailed** `401`
>
> The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **Forbidden** `403`
>
> The key may not do this: a scope it lacks, or an address outside its allowlist. `siteMessage` names it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteError** `500`
>
> The site failed. Its logs say why.
>
> **Retried first:** No: a write may have landed. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteUnreachable** `no answer`
>
> No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).
>
> **Retried first:** Only when nothing reached the site (`neverConnected()`); never after a timeout, when it may have landed. **Read:** `reason`, `neverConnected`.
>
> **RequestNotSent** `not sent`
>
> The client refused to send it (e.g. a path segment of `..`); the site never saw it.
>
> **Retried first:** No. **Read:** `reason` (what to change).
>
> **SiteRequestFailed** `any other`
>
> Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).
>
> **Retried first:** No. **Read:** `reason`, `status`.
>
> **UnknownSite** `setup`
>
> `sites.forSite('acme')` named a slug `config/attract.ts` doesn’t list (with the keys in the database: no row in `attract_api_keys`).
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s entry is wrong: a malformed `baseUrl` or key, a key filed under another slug, or no default site. `node ace attract:check` names the fix.
>
> **Retried first:** No: nothing was sent. **Read:** `message` (what to fix).

## Behavior

* **Access:** an API key with `content:redirects:write` (or a master above it: `content:redirects:all`, `content:all`, `admin:all`). A signed-in person may call it as far as their own permissions allow; anyone else gets 403.
* **Rate limit:** the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with `Retry-After`. The client waits and retries for you; you see `RateLimited` only if that runs out.
* **Retries:** a write is sent again only after a 429 (refused before it acted) or when it never reached the site. After a timeout or a 5xx it may have landed: check before you send it again.
* **Timeout:** 15 s per attempt by default; raise `timeout` (milliseconds) in `config/attract.ts` for longer.

## Test it

It calls the controller above with the SDK faked: `fakeAttract()` puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as `tests/unit/redirects_replace_redirect.spec.ts`, then run your tests:

```ts tests/unit/redirects_replace_redirect.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import testUtils from '@adonisjs/core/services/test_utils'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import ReplaceRedirectController from '#controllers/replace_redirect_controller'

test('redirects.replaceRedirect', async () => {
  const site = fakeAttract()

  const ctx = await testUtils.createHttpContext()
  ctx.params = { id: 'clx8m2k4p0000a1b2c3d4e5f6' }
  const controller = await app.container.make(ReplaceRedirectController)
  await controller.handle(ctx)

  site.assertCalled('redirects.replaceRedirect', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6')
})
```

```bash Terminal theme={"dark"}
node ace test
```

**Answer with your own values:** fake `redirects.replaceRedirect` with `factories.Redirect({...})`, the fields you give over a valid example.

```ts tests/unit/redirects_replace_redirect_answers.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import { factories, fakeAttract } from '@fetchski/attract-cms-adonis/testing'

test('redirects.replaceRedirect answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'redirects.replaceRedirect': factories.Redirect({ title: 'Your value' }),
  })

  const redirect = await site.redirects().replaceRedirect({ id: 'clx8m2k4p0000a1b2c3d4e5f6', title: 'Example title', redirectSlug: 'example-slug' })
  assert.containSubset(redirect, { title: 'Your value' })
})
```

## Related

> [card] [List redirects](https://docs.fetchski-attract.com/adonisjs/reference/redirects/list-redirects.md)
>
> `site.redirects().listRedirects()`

> [card] [Create a redirect](https://docs.fetchski-attract.com/adonisjs/reference/redirects/create-redirect.md)
>
> `site.redirects().createRedirect()`

> [card] [Get a redirect](https://docs.fetchski-attract.com/adonisjs/reference/redirects/get-redirect.md)
>
> `site.redirects().getRedirect()`

> [card] [Delete a redirect](https://docs.fetchski-attract.com/adonisjs/reference/redirects/delete-redirect.md)
>
> `site.redirects().deleteRedirect()`

> [card] [Update a redirect](https://docs.fetchski-attract.com/adonisjs/reference/redirects/update-redirect.md)
>
> `site.redirects().updateRedirect()`

> [card] [Archive redirects](https://docs.fetchski-attract.com/adonisjs/reference/redirects/archive-redirects.md)
>
> `site.redirects().archiveRedirects()`

> [card] [PUT /@apostrophecms/redirect/\{\_id}](https://docs.fetchski-attract.com/api-reference/redirects/replace-a-redirect.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.