POST /zones/{zone_id}/token_validation/rules/preview

Preview operations covered by a Token Validation rule.

The API will return all operations on a zone annotated with an additional state field. Operations with an included state will be covered by a Token Validation Rule.

Servers

Path parameters

Name Type Required Description
zone_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
page Integer No

Page number of paginated results.

Default value: 1

method[] Array No

Filter operations by method.

per_page Integer No

Maximum number of results per page.

Default value: 20

hostname[] Array No

Filter operations by host.

state[] Array No
host[] Array No

Filter operations by host.

endpoint[] Array No

Filter operations by endpoint. Allows substring matching.

Request body fields

Name Type Required Description
include[] Array No

Select all matching operations.

include[].host[] Array No

Included hostnames.

exclude[] Array No

Ignore operations that were otherwise included by include.

exclude[].operation_ids[] Array No

Excluded operation IDs.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.