pydo.reserved_ips.get()

Generated on 25 November 2024 from pydo version v0.6.0

Description

To show information about a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP_ADDR.

Parameters

Name	Type	Required	Description	Default Value
`reserved_ip`	string	True	A reserved IP address.

Request Sample

import os
from pydo import Client

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

resp = client.reserved_ips.get(reserved_ip="45.55.96.47")

Responses

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

200
401
404
429
500
default

The response will be a JSON object with a key called reserved_ip. The value of this will be an object that contains the standard attributes associated with a reserved IP.

Click to expand an example response for reserved_ip_assigned.

{
  "summary": "Assigned to Droplet",
  "value": {
    "reserved_ip": {
      "ip": "45.55.96.47",
      "droplet": {
        "id": 3164444,
        "name": "example.com",
        "memory": 1024,
        "vcpus": 1,
        "disk": 25,
        "locked": false,
        "status": "active",
        "kernel": null,
        "created_at": "2020-07-21T18:37:44Z",
        "features": [
          "backups",
          "private_networking",
          "ipv6"
        ],
        "backup_ids": [
          53893572
        ],
        "next_backup_window": {
          "start": "2020-07-30T00:00:00Z",
          "end": "2020-07-30T23:00:00Z"
        },
        "snapshot_ids": [
          67512819
        ],
        "image": {
          "id": 63663980,
          "name": "20.04 (LTS) x64",
          "type": "base",
          "distribution": "Ubuntu",
          "slug": "ubuntu-20-04-x64",
          "public": true,
          "regions": [
            "ams2",
            "ams3",
            "blr1",
            "fra1",
            "lon1",
            "nyc1",
            "nyc2",
            "nyc3",
            "sfo1",
            "sfo2",
            "sfo3",
            "sgp1",
            "tor1"
          ],
          "created_at": "2020-05-15T05:47:50Z",
          "min_disk_size": 20,
          "size_gigabytes": 2.36,
          "description": "",
          "tags": [],
          "status": "available",
          "error_message": ""
        },
        "volume_ids": [],
        "size": {
          "slug": "s-1vcpu-1gb",
          "memory": 1024,
          "vcpus": 1,
          "disk": 25,
          "transfer": 1,
          "price_monthly": 5,
          "price_hourly": 0.00743999984115362,
          "regions": [
            "ams2",
            "ams3",
            "blr1",
            "fra1",
            "lon1",
            "nyc1",
            "nyc2",
            "nyc3",
            "sfo1",
            "sfo2",
            "sfo3",
            "sgp1",
            "tor1"
          ],
          "available": true,
          "description": "Basic"
        },
        "size_slug": "s-1vcpu-1gb",
        "networks": {
          "v4": [
            {
              "ip_address": "10.128.192.124",
              "netmask": "255.255.0.0",
              "gateway": "nil",
              "type": "private"
            },
            {
              "ip_address": "192.241.165.154",
              "netmask": "255.255.255.0",
              "gateway": "192.241.165.1",
              "type": "public"
            }
          ],
          "v6": [
            {
              "ip_address": "2604:a880:0:1010::18a:a001",
              "netmask": 64,
              "gateway": "2604:a880:0:1010::1",
              "type": "public"
            }
          ]
        },
        "region": {
          "name": "New York 3",
          "slug": "nyc3",
          "features": [
            "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"
          ]
        },
        "tags": [
          "web",
          "env:prod"
        ],
        "vpc_uuid": "760e09ef-dc84-11e8-981e-3cfdfeaae000"
      },
      "region": {
        "name": "New York 3",
        "slug": "nyc3",
        "features": [
          "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"
    }
  }
}

Click to expand an example response for reserved_ip_reserved.

{
  "summary": "Reserved to Region",
  "value": {
    "reserved_ip": {
      "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"
    }
  }
}

Unauthorized