Skip to main content
GET
Python (SDK)

Authorizations

Authorization
string
header
required

Query Parameters

filter[server]
string

The server ID to filter by

filter[project]
string

The project ID or Slug to filter by

filter[family]
enum<string>

The protocol family to filter by

Available options:
IPv4,
IPv6
filter[type]
enum<string>

The protocol type to filter by

Available options:
private,
public,
elastic
filter[location]
string

The site slug to filter by

filter[address]
string

The address of IP to filter by starts_with

filter[additional]
boolean

Filter by additional IPs (true) or management IPs (false)

filter[available]
boolean

Filter by unassigned IPs (true) or assigned IPs (false)

filter[management]
boolean

Filter by management IPs (true) or additional/elastic IPs (false)

extra_fields[ip_addresses]
string

The region and server are provided as extra attributes that are lazy loaded. To request it, just set extra_fields[ip_addresses]=region,server in the query string.

page[size]
integer
default:20

Number of items to return per page

Required range: x >= 1
page[number]
integer
default:1

Page number to return (starts at 1)

Required range: x >= 1
stats[total]
string

Request aggregate stats in the response meta. Use count to get the total number of records, returned as meta.stats.total.count.

sort
string

Comma-separated sort fields. Prefix a field with - for descending order. Supported fields: address, family, type, created_at. Example: sort=type,-created_at sorts by type ascending, then by creation date descending.

Response

200 - application/vnd.api+json

Success

data
object[]
meta
object