Skip to navigation

List a network's access rules

With no rules a network shows every location of its CPOs.

Authentication

AuthorizationBearer

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

Path parameters

network_idintegerRequired>=1

The network’s network_id.

Query parameters

validityenum or nullOptional

Only rules in effect now (ACTIVE), later, or ended; default ALL.

Allowed values:
afterstring or nullOptional1-255 characters

Cursor: the previous page’s pagination.end_cursor. Omit it for the first page.

limitintegerOptional1-200Defaults to 50

Maximum rows per page (default 50, max 200).

Response

One page of access rules.
datalist of objects
paginationobject

Spirii cursor page. Pass end_cursor as the next after value.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error