hosting

GET /v1/sites/{siteId}/redirects

List a site's redirects.

All hosting endpoints

Authentication

Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/redirects \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

The redirect rules the site serves: which domain and path is redirected, where to, and with which status. `id` is **ours, not the vendor's** — this platform mints no identifier for a redirect, so this encodes the domain/type/path triple that addresses one. It is opaque, stable across reads, and must not be stored as a key. Requires `sites.view` — what a site redirects is not a secret. `404` for a site with no managed hosting package.

Parameters

NameTypeRequiredWhat it is
siteId (path)UuidYesSite ID (UUIDv7).

Response

NameTypeRequiredWhat it is
dataSiteRedirect[]YesThe redirect rules on the package.
limitVendorAllowanceYesThe effective ceiling on redirects. As with scheduled tasks, the platform publishes this capability as a boolean with no count.
permittedbooleanYesWhether the package type includes redirects at all.
can_createbooleanYes`permitted`, **and** the effective ceiling has room.

Errors this endpoint can return

401 · 403 · 404 · 429 · 503