Reference > PyDo > Library Reference > reserved_ips > list()

Was this page helpful?

Give Feedback

pydo.reserved_ips.list()

Generated on 25 November 2024 from pydo version v0.6.0

Description

To list all of the reserved IPs available on your account, send a GET request to /v2/reserved_ips.

Parameters

Name	Type	Required	Description	Default Value
`per_page`	integer	False	Number of items returned per page	20
`page`	integer	False	Which ‘page’ of paginated results to return.	1

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

resp = client.reserved_ips.list()

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

200
401
429
500
default

The response will be a JSON object with a key called reserved_ips. This will be set to an array of reserved IP objects, each of which will contain the standard reserved IP attributes

Click to expand an example response.

{
  "reserved_ips": [
    {
      "ip": "45.55.96.47",
      "droplet": null,
      "region": {
        "name": "New York 3",
        "slug": "nyc3",
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata",
          "install_agent",
          "storage",
          "image_transfer"
        ],
        "available": true,
        "sizes": [
          "s-1vcpu-1gb",
          "s-1vcpu-2gb",
          "s-1vcpu-3gb",
          "s-2vcpu-2gb",
          "s-3vcpu-1gb",
          "s-2vcpu-4gb",
          "s-4vcpu-8gb",
          "s-6vcpu-16gb",
          "s-8vcpu-32gb",
          "s-12vcpu-48gb",
          "s-16vcpu-64gb",
          "s-20vcpu-96gb",
          "s-24vcpu-128gb",
          "s-32vcpu-192g"
        ]
      },
      "locked": false,
      "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"
    }
  ],
  "links": {},
  "meta": {
    "total": 1
  }
}

Unauthorized

Click to expand an example response.

{
  "id": "unauthorized",
  "message": "Unable to authenticate you."
}

API Rate limit exceeded

Click to expand an example response.

{
  "id": "too_many_requests",
  "message": "API Rate limit exceeded."
}

Server error.

Click to expand an example response.

{
  "id": "server_error",
  "message": "Unexpected server-side error"
}

Unexpected error

Click to expand an example response.

{
  "id": "example_error",
  "message": "some error message"
}