Skip to content

List a zone redirect map

GET
/api/zones/{zoneId}/redirect-map

Returns the zone's path-level redirect map as a paginated collection: one member per redirect, each mapping an exact source ("host/path") to a target with a mode and an HTTP redirect status. Filter with search, order the whole (filtered) map with order[<field>] (source, target, mode, status), and page with page and itemsPerPage (max 500). totalItems is the number of entries matching the current search.

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

zoneId*

Zone 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
50
Minimum
0
Maximum
500
search

Case-insensitive substring match on source or target.

Type
string
order[source]

Sort by source. Any of source, target, mode or status is sortable via order[]; sorting is applied server-side across the whole (filtered) map.

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

Sort by target.

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

Sort by mode.

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

Sort by status.

Type
string
Valid values
"asc""desc"

Responses

redirect-map 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",
  
  
  
"source": "www.example.com/old",
  
  
  
"target": "https://www.example.com/new",
  
  
  
"mode": "L",
  
  
  
"status": 301
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI