Get details of a custom response rule

GET

/api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule}

const url = 'https://dashboard.quantcdn.io/api/v2/organizations/example/projects/example/rules/custom-response/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dashboard.quantcdn.io/api/v2/organizations/example/projects/example/rules/custom-response/example \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

organization

required

string

Organization identifier

project

required

string

Project identifier

rule

required

string

Rule identifier

Responses

200

The request has succeeded.

application/json

object

name

Rule name

string

uuid

required

Rule UUID

string

rule_id

Rule ID

string

weight

Rule order. Must be 0 or greater; lower weights are processed first. If omitted on create, the rule is placed last.

integer

url

URL patterns

Array<string>

domain

Exact hostnames the rule matches, or ‘any’. Wildcards are not supported.

Array<string>

disabled

required

Whether rule is disabled

boolean

only_with_cookie

Only apply with cookie

string

method

HTTP method

string

method_is

Allowed HTTP methods

Array<string>

method_is_not

Excluded HTTP methods

Array<string>

IP address

string

ip_is

Allowed IP addresses

Array<string>

ip_is_not

Excluded IP addresses

Array<string>

asn

ASN condition type (asn_is, asn_is_not, any). Returned for rules set in the dashboard; this API does not set ASN conditions on create or update.

string

asn_is

Allowed AS numbers

Array<string>

asn_is_not

Excluded AS numbers

Array<string>

country

Country code

string

country_is

Allowed countries

Array<string>

country_is_not

Excluded countries

Array<string>

action

required

Rule action

string

action_config

object

custom_response_body

required

Custom response body content

string

custom_response_status_code

HTTP status code for custom response

integer

default: 200

Example

{
  "name": "Test redirect rule",
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "rule_id": "rule-001",
  "weight": 100,
  "url": [
    "/old-path/*",
    "/legacy/*"
  ],
  "domain": [
    "test-domain.com",
    "www.test-domain.com"
  ],
  "disabled": false,
  "only_with_cookie": "session_id",
  "method": "GET",
  "method_is": [
    "GET",
    "POST"
  ],
  "method_is_not": [
    "DELETE",
    "PUT"
  ],
  "ip": "192.168.1.1",
  "ip_is": [
    "192.168.1.0/24",
    "10.0.0.1"
  ],
  "ip_is_not": [
    "172.16.0.0/12"
  ],
  "asn": "any",
  "asn_is": [
    "15169",
    "8075"
  ],
  "asn_is_not": [
    "13335"
  ],
  "country": "US",
  "country_is": [
    "US",
    "CA",
    "GB"
  ],
  "country_is_not": [
    "CN",
    "RU"
  ],
  "action": "redirect",
  "action_config": {
    "custom_response_body": "<html><body>Custom maintenance page</body></html>",
    "custom_response_status_code": 200
  }
}

400

The server could not understand the request due to invalid syntax.

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

Example

{
  "message": "The requested resource was not found",
  "error": true
}

403

Access is forbidden.

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

Example

{
  "message": "The requested resource was not found",
  "error": true
}