Skip to main content
GET
/
ips
Typescript (SDK)
import { Latitudesh } from "latitudesh-typescript-sdk";

const latitudesh = new Latitudesh({
  bearer: process.env["LATITUDESH_BEARER"] ?? "",
});

async function run() {
  const result = await latitudesh.ipAddresses.list({});

  for await (const page of result) {
    console.log(page);
  }
}

run();
{
  "data": [
    {
      "id": "ip_5AEmq7wXqBkWX",
      "type": "ip_addresses",
      "attributes": {
        "address": "110.190.5.254",
        "cidr": null,
        "family": "IPv4",
        "gateway": null,
        "netmask": "255.255.255.255",
        "type": "Public",
        "public": true,
        "management": true,
        "additional": false,
        "project": {
          "id": "proj_lkg1DeVgOvZE5",
          "name": "Incredible Silk Keyboard"
        },
        "region": {},
        "available": true,
        "assignment": {}
      }
    },
    {
      "id": "ip_Gr47qleMDAg0m",
      "type": "ip_addresses",
      "attributes": {
        "address": "180.228.210.136",
        "cidr": null,
        "family": "IPv4",
        "gateway": null,
        "netmask": "255.255.255.255",
        "type": "Public",
        "public": true,
        "management": true,
        "additional": false,
        "project": {
          "id": "proj_lkg1DeVgOvZE5",
          "name": "Incredible Silk Keyboard"
        },
        "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

​
filter[additional]
boolean

Filter by additional IPs (true) or management 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

Response

200 - application/vnd.api+json

Success

​
data
object[]