v7

OpenAPI 3.0.12026-08-03158127387.0 KB

IP Addresses

List IPs

List all Management and Additional IP Addresses. • Management IPs are IPs that are used for the management IP of a device. This is a public IP address that a device is born and dies with. It never changes during the lifecycle of the device. • Additional IPs are individual IPs that can be added to a device as an additional IP that can be used.

get/ips

Query parameters

filter[server]string

The server ID to filter by

filter[project]string

The project ID or Slug to filter by

filter[family]'IPv4' | 'IPv6'

The protocol family to filter by

filter[type]'private' | 'public' | 'elastic'

The protocol type to filter by

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

Number of items to return per page

page[number]integer

Page number to return (starts at 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.

sortstring

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

Success