Create a redirect

use Fetchski\AttractCmsLaravel\Facades\Attract;

$redirect = Attract::redirects()->createRedirect(title: 'Example title', redirectSlug: 'example-slug');

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

use Fetchski\AttractCmsLaravel\Facades\Attract;

$redirect = Attract::redirects()->createRedirect(title: 'Example title', redirectSlug: 'example-slug');

{
  "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 createRedirect() and returns the answer.

Add the controller

app/Http/Controllers/CreateRedirectController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Data\Redirect;
use Fetchski\AttractCmsLaravel\Facades\Attract;

final class CreateRedirectController
{
    public function __invoke(): Redirect
    {
        return Attract::redirects()->createRedirect(title: 'Example title', redirectSlug: 'example-slug');
    }
}

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

Add the route

routes/web.php

use App\Http\Controllers\CreateRedirectController;
use Illuminate\Support\Facades\Route;

Route::post('/redirect', CreateRedirectController::class)->middleware('auth');

It acts with your key’s access, so auth lets only your signed-in users reach it.

Call it

Your own page’s form or script sends POST /redirect (a form adds @csrf, as every web route checks it), and gets back its answer as JSON. Test it, below, calls it.

To keep the call in an Action instead, this writes app/Actions/Attract/CreateRedirect.php (an invokable Action that calls createRedirect()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action redirects.createRedirect

Call it from the terminal

Terminal

php artisan attract:call redirects.createRedirect 'title=Example title' redirectSlug=example-slug

It calls createRedirect() on your default site and prints its answer as JSON. It writes, so it asks first: add --force to skip the question in a script. See Call any method from the terminal for every argument type.

Required parameters

Named arguments, e.g. createRedirect(title: …); leave out the optional ones.

string

required

Required. Its title: the name it goes by in every list, and the heading of its page where it has one.

string

required

Required. Format with leading slash (e.g., /old-url)

Optional parameters

Enums\UrlType|string|null

Optional. Leave it out and the site uses "internal". Link Type. One of internal, external.

array<int, array<string, mixed>>|Collection<int, array<string, mixed>>|null

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.

?string

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.

Enums\StatusCode|string|null

Optional. Leave it out and the site uses "301". Redirect Type. One of 302, 301.

?bool

Optional. Leave it out and the site uses false. Ignore query string when matching.

?bool

Optional. Leave it out and the site uses false. Forward query string.

?string

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.

?bool

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.

Returns

A Redirect (Fetchski\AttractCmsLaravel\Data\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).

string

Always sent. Its title: the name it goes by in every list, and the heading of its page where it has one.

string

Always sent. Format with leading slash (e.g., /old-url)

string

Always sent. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).

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.

string

Always sent. The document type’s name: always this type’s.

CarbonImmutable

Always sent. When it was created (ISO 8601). Format: an ISO 8601 date and time.

CarbonImmutable

Always sent. When it last changed (ISO 8601). Format: an ISO 8601 date and time.

Enums\UrlType|string|null

Sometimes sent: null when the site leaves it out. Link Type. One of internal, external; a newer site may send others, so keep a fallback.

Collection<int, array<string, mixed>>|null

Sometimes sent: null when the site leaves it out. 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.

?string

Sometimes sent: null when the site leaves it out. When set, a URL; empty or null when not.

Enums\StatusCode|string|null

Sometimes sent: null when the site leaves it out. Redirect Type. One of 302, 301; a newer site may send others, so keep a fallback.

?bool

Sometimes sent: null when the site leaves it out. Ignore query string when matching.

?bool

Sometimes sent: null when the site leaves it out. Forward query string.

?bool

Sometimes sent: null when the site leaves it out. In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.

Errors

Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).

400

The site refused what was sent: errors() lists each field’s problem, siteMessage() the first.Retried first: No. Read: errors() (field → messages), siteMessage().

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().

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().

404

Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage(), errorName(), data().

500

The site failed. Its logs say why.Retried first: No: a write may have landed. Read: siteMessage(), errorName(), data().

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().

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).

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().

setup

Attract::site('acme') named a slug that isn’t under sites in config/fetchski-attract.php.Retried first: No: nothing was sent. Read: getMessage(), $e->slug.

setup

The site’s config entry is wrong: no url, a malformed api_key, a key filed under another slug, or no default site.Retried first: No: nothing was sent. Read: getMessage() (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 in config/fetchski-attract.php for longer.

Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as tests/Feature/CreateRedirectTest.php, then run your tests:

tests/Feature/CreateRedirectTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use App\Models\User;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

final class CreateRedirectTest extends TestCase
{
    use RefreshDatabase;

    public function test_create_redirect(): void
    {
        Attract::fake();

        $this->actingAs(User::factory()->create())
            ->postJson('/redirect')
            ->assertOk();

        Attract::assertCalled('redirects.createRedirect');
    }
}

Terminal

php artisan test

Answer with your own values: fake redirects.createRedirect with Redirect::factory()->make([...]), the fields you give over a valid example.

tests/Feature/CreateRedirectAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Data\Redirect;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class CreateRedirectAnswerTest extends TestCase
{
    public function test_create_redirect_answers_your_values(): void
    {
        Attract::fake([
            'redirects.createRedirect' => Redirect::factory()->make(['title' => 'Your value']),
        ]);

        $redirect = Attract::redirects()->createRedirect(title: 'Example title', redirectSlug: 'example-slug');

        $this->assertSame('Your value', $redirect->title);
    }
}

List redirects

Attract::redirects()->listRedirects()

Get a redirect

Attract::redirects()->getRedirect()

Replace a redirect

Attract::redirects()->replaceRedirect()

Delete a redirect

Attract::redirects()->deleteRedirect()

Update a redirect

Attract::redirects()->updateRedirect()

Archive redirects

Attract::redirects()->archiveRedirects()

POST /@apostrophecms/redirect

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

use Fetchski\AttractCmsLaravel\Facades\Attract;

$redirect = Attract::redirects()->createRedirect(title: 'Example title', redirectSlug: 'example-slug');

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

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Call it from the terminal

Behavior

Test it

List redirects

Get a redirect

Replace a redirect

Delete a redirect

Update a redirect

Archive redirects

POST /@apostrophecms/redirect

In your app

Call it from the terminal

Behavior

Test it

Related

List redirects

Get a redirect

Replace a redirect

Delete a redirect

Update a redirect

Archive redirects

POST /@apostrophecms/redirect