Skip to main content
GET
List allowed IP address ranges

Authorizations

Authorization
string
header
required

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

Path Parameters

organizationId
string
required

The ID of the Organization that you want to retrieve the list of IP addresses for.

Query Parameters

offset
integer
default:0

The number of results to skip before returning values.

Required range: x >= 0
limit
integer
default:20

The maximum number of results to return.

Required range: x >= 0
sorts
enum<string>[]

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

Available options:
ipAddress:asc,
ipAddress:desc,
createdAt:asc,
createdAt:desc,
updatedAt:asc,
updatedAt:desc

Response

OK

allowedIpAddressRanges
object[]
required
limit
integer
required

The maximum number of allowed IP address ranges in one page.

Example:

10

offset
integer
required

The offset of the current page of allowed IP address ranges.

Example:

0

totalCount
integer
required

The total number of allowed IP address ranges.

Example:

10