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.
Authorizations
Query Parameters
The server ID to filter by
The project ID or Slug to filter by
The protocol family to filter by
IPv4, IPv6 The protocol type to filter by
private, public, elastic The site slug to filter by
The address of IP to filter by starts_with
Filter by additional IPs (true) or management IPs (false)
Filter by unassigned IPs (true) or assigned IPs (false)
Filter by management IPs (true) or additional/elastic IPs (false)
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.
Number of items to return per page
x >= 1Page number to return (starts at 1)
x >= 1Request aggregate stats in the response meta. Use count to get the total number of records, returned as meta.stats.total.count.
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.