Skip to main content
GET
/
ips
Python (SDK)
from latitudesh_python_sdk import Latitudesh
import os


with Latitudesh(
    bearer=os.getenv("LATITUDESH_BEARER", ""),
) as latitudesh:

    res = latitudesh.ip_addresses.list(filter_server="46", filter_project="59", page_size=20, page_number=1)

    while res is not None:
        # Handle items

        res = res.next()
{
  "data": [
    {
      "id": "ip_wg3ZDr23D5QlP",
      "type": "ip_addresses",
      "attributes": {
        "address": "112.74.133.123",
        "cidr": null,
        "family": "IPv4",
        "gateway": null,
        "netmask": "255.255.255.255",
        "type": "Public",
        "public": true,
        "management": true,
        "project": {
          "id": "proj_RMLydp20DQKr1",
          "name": "Intelligent Silk Computer"
        },
        "region": {},
        "available": true,
        "assignment": {}
      }
    },
    {
      "id": "ip_k0Ryqvz1qW36X",
      "type": "ip_addresses",
      "attributes": {
        "address": "24.156.198.223",
        "cidr": null,
        "family": "IPv4",
        "gateway": null,
        "netmask": "255.255.255.255",
        "type": "Public",
        "public": true,
        "management": true,
        "project": {
          "id": "proj_RMLydp20DQKr1",
          "name": "Intelligent Silk Computer"
        },
        "region": {},
        "available": true,
        "assignment": {}
      }
    }
  ],
  "meta": {}
}

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
filter[location]
string

The site slug to filter by

filter[address]
string

The address of IP to filter by starts_with

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

Response

200 - application/vnd.api+json

Success

data
object[]
I