List redirects for an organization
Returns redirects owned by the organization, paginated. Each redirect exposes its source hostname, target hostname, mode, the generated CNAME target, and the current DNS target verification status of the source hostname. Pass q to filter by source hostname, target hostname or CNAME target, and mode or dnsTargetStatus to narrow the list to one or several modes or DNS statuses.
Authorizations
Long-lived API token created via POST /api/api-tokens (returned once in plaintext). A token created with readOnly may only perform safe requests (GET, HEAD, OPTIONS); write requests are rejected on every endpoint.
JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer
Parameters
Path Parameters
Organization identifier
Query Parameters
The collection page number
1The number of items per page
300100Partial, case-insensitive match on source hostname, target hostname or generated CNAME target. Combine with page/itemsPerPage to page the results.
Sort by source hostname, ascending or descending.
"asc""desc"Sort by target hostname, ascending or descending.
"asc""desc"Sort by redirect mode, ascending or descending.
"asc""desc"Filter by redirect mode (exact): path or domain. Repeat as mode[] to match any of several modes.
Filter by redirect mode (exact): path or domain. Repeat as mode[] to match any of several modes.
Filter by the DNS target status of the source hostname (exact): pending, valid, degraded, invalid or proxied. Repeat as dnsTargetStatus[] to match any of several statuses.
Filter by the DNS target status of the source hostname (exact): pending, valid, degraded, invalid or proxied. Repeat as dnsTargetStatus[] to match any of several statuses.
Responses
redirect collection