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 present, returns only owned rules. This is a flag: the value is not read, so owned_only=false still enables it. Ignored for unauthenticated requests.

shared_only
boolean

If present, returns only shared (not owned) rules. This is a flag: the value is not read, so shared_only=false still enables it. Ignored for unauthenticated requests.

tag
string[]

Check whether tag is presented. Repeat the parameter to pass several tags; a rule matches if any of them is attached to it. If any value is invalid the whole filter is ignored.

company_id
integer<int64>[]

Check whether owned by the company. Repeat the parameter to pass several ids. If any value is invalid the whole filter is ignored.

page
integer<int64>
default:1

Number of page. Starts from the first (1) page. A value that is not a non-negative integer gets a 404 with an empty body.

Required range: x >= 0
per_page
integer
default:100

Number of records to return. Defaults to 100. A value that is not a positive integer gets a 404 with an empty body.

Required range: x >= 1
dataset_id
integer<int64>[]

Check whether the rule is associated with specified dataset. Repeat the parameter to pass several ids. If any value is invalid the whole filter is ignored.

data_plane_id
string<uuid>

When set, only access rules on this data plane are returned. Omitted returns rules on any plane. A value that is not a UUID gets a 404 with an empty body.

q
string

Free-text search term. When provided, access rules are ranked by their relevance to the search term.

Response

200 - application/json

OK

records
object[]
required

An access rule as seen by the caller. The owning company gets the full rule (type is owned); everyone else, including unauthenticated callers, gets the reduced shared form.

Example:
current_page
integer<int64>
required

The number of requested page.

Example:

1

total_records
integer<int64>
required

Total amount of accessible Access Rules

Example:

15000

total_pages
integer<int64>
required

Total amount of pages.

Example:

10

prev_page
integer<int64> | null

The number of the previous page, or null on the first page. Can also refer to the latest existing page if a page beyond the last one was requested.

Example:

1

next_page
integer<int64> | null

The number of the next page, or null on the last page.

Example:

42