Sign in

v1

latestOpenAPI 3.1.02026-07-241765501.1 MB
Redirect rules

Retrieve redirect rules

🔐 This endpoint requires HTTP authentication (either Basic or Bearer). For authenticating with Bearer token, required scopes are: redirects(r).

Retrieve all redirect rules

get/v1/redirect_rules

Query parameters

keystring required

The key of the index to use.

Example:key_K2pX7vBnU0bgA5xp
integer
OR
integer[]
querystring

A search query for redirect rules.

Example:take me here
num_results_per_pageinteger

The number of results per page to return.

Example:20
pageinteger

The page of results to return.

Example:1
offsetinteger

The number of results to skip from the beginning. Cannot be used together with page.

sort_order'ascending' | 'descending'
status'current' | 'pending' | 'expired'

A filter by status of redirect rules.

Example:current
cstring

The ID of the client and version that the request is coming from, such as cio-js-2.90.

Example:cio-js-2.90

Response

OK

total_countinteger required

The total count of redirect rules.

Example response

{
  "redirect_rules": [
    {
      "matches": [
        {
          "pattern": "take me here",
          "match_type": "EXACT"
        }
      ]
    }
  ]
}