Skip to main content
GET
Get all accessible Access Rules (V2)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

owned_only
boolean

If enabled, returns only owned rules.

shared_only
boolean

If enabled, returns only shared (not owned) rules.

tag
string

Check whether tag is presented. If multiple tags specified, looks if any of them is attached to a rule.

company_id
integer

Check whether owned by the company. Can be specified multiple times.

page
integer

Number of page. Stars from the first (1) page.

per_page
integer

Number of records to return.

dataset_id
integer

Check whether the rule is associated with specified dataset. Multiple values are allowed.

data_plane_id
string<uuid>

When set, only access rules on this data plane are returned. Omitted returns rules on any plane.

Response

200 - application/json

OK

records
object[]
required
Example:
prev_page
integer<int64>

The number of previous page (if exists). Also can refer to the latest existing page if non-existing page was requested.

Example:

1

current_page
integer<int64>

The number of requested page.

Example:

1

next_page
integer<int64>

The number of next page (if exists).

Example:

42

total_records
integer<int64>

Total amount of accessible Access Rules

Example:

15000

total_pages
integer<int64>

Total amount of pages.

Example:

10