List rewrite rules for a zone
GET
/api/zones/{zoneId}/rewrite-rules
Returns all URL rewrite rules configured on the zone, ordered by their execution order. Use the "name" query parameter to filter by a partial name match.
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
zoneId*
Zone identifier
Type
Requiredstring
Query Parameters
page
The collection page number
Type
integer
Default
1itemsPerPage
The number of items per page
Type
integer
Default
30Minimum
0Maximum
100name
Filter rules by name using a case-insensitive partial (substring) match.
Type
string
name[]
Filter rules by name using a case-insensitive partial (substring) match.
Type
array
Responses
rewrite-rule 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": "string", "zone": "https://example.com/", "name": "Redirect old blog paths", "description": "Rewrites legacy /blog/* URLs to the new /articles/* structure.", "operator": "regex", "sourcePattern": "^/blog/(.*)$", "target": "/articles/$1", "order": 0, "enabled": true, "createdAt": "string", "updatedAt": "string" } ]
{
}