Reference > PyDo > Library Reference > reserved_ips_actions > list()

Was this page helpful?

Give Feedback

pydo.reserved_ips_actions.list()

Generated on 25 November 2024 from pydo version v0.6.0

Description

To retrieve all actions that have been executed on a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions.

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_actions.list(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 results will be returned as a JSON object with an actions key. This will be set to an array filled with action objects containing the standard reserved IP action attributes.

Click to expand an example response.

{
  "actions": [
    {
      "id": 72531856,
      "status": "completed",
      "type": "reserve_ip",
      "started_at": "2015-11-21T21:51:09Z",
      "completed_at": "2015-11-21T21:51:09Z",
      "resource_id": 758604197,
      "resource_type": "reserved_ip",
      "region": {
        "name": "New York 3",
        "slug": "nyc3",
        "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-192gb"
        ],
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata"
        ],
        "available": true
      },
      "region_slug": "nyc3"
    }
  ],
  "links": {},
  "meta": {
    "total": 1
  }
}

Unauthorized

Click to expand an example response.

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

The resource was not found.

Click to expand an example response.

{
  "id": "not_found",
  "message": "The resource you requested could not be found."
}

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"
}