Skip to content

List redirects for an organization

GET
/api/organizations/{organizationId}/redirects

Returns every redirect owned by the organization. Each redirect exposes its source hostname, target hostname, mode, the generated CNAME target, and the current DNS target verification status of the source hostname.

Authorizations

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext).

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

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