Skip to content

List redirects for an organization

GET
/api/organizations/{organizationId}/redirects

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 search to filter by source hostname, target hostname or CNAME target.

Authorizations

ApiToken

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.

Type
API Key (header: X-API-TOKEN)
or
JWT

JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer .

Type
HTTP (bearer)

Parameters

Path Parameters

organizationId*

Organization identifier

Type
string
Required

Query Parameters

page

The collection page number

Type
integer
Default
1
itemsPerPage

The number of items per page

Type
integer
Default
30
Minimum
0
Maximum
100
search

Partial, case-insensitive match on source hostname, target hostname or generated CNAME target. Combine with page/itemsPerPage to page the results.

Type
string
order[sourceHostname]

Sort by source hostname, ascending or descending.

Type
string
Valid values
"asc""desc"
order[targetHostname]

Sort by target hostname, ascending or descending.

Type
string
Valid values
"asc""desc"
order[mode]

Sort by redirect mode, ascending or descending.

Type
string
Valid values
"asc""desc"

Responses

redirect collection

JSON
{
  
"totalItems": 0,
  
"search": {
  
  
"@type": "string",
  
  
"template": "string",
  
  
"variableRepresentation": "string",
  
  
"mapping": [
  
  
  
{
  
  
  
  
"@type": "string",
  
  
  
  
"variable": "string",
  
  
  
  
"property": "string",
  
  
  
  
"required": true
  
  
  
}
  
  
]
  
},
  
"view": {
  
  
"@id": "string",
  
  
"@type": "string",
  
  
"first": "string",
  
  
"last": "string",
  
  
"previous": "string",
  
  
"next": "string"
  
},
  
"member": [
  
  
{
  
  
  
"@context": "string",
  
  
  
"@id": "string",
  
  
  
"@type": "string",
  
  
  
"id": 42,
  
  
  
"targetHostname": "www.example.com",
  
  
  
"mode": "path",
  
  
  
"createdAt": "2026-07-01T12:34:56+00:00",
  
  
  
"updatedAt": "2026-07-01T12:34:56+00:00",
  
  
  
"sourceHostname": "old.example.com",
  
  
  
"cnameTarget": "abc123.cname.smoxy.eu",
  
  
  
"dnsTargetStatus": "pending",
  
  
  
"dnsObservedValue": "abc123.cname.smoxy.eu",
  
  
  
"dnsLastCheckedAt": "2026-07-01T12:34:56+00:00",
  
  
  
"domain": "https://example.com/"
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI