Sign in
DigitalOcean-public.v2-new_Reserved IP Actions

Initiate a Reserved IP Action

To initiate an action on a reserved IP send a POST request to /v2/reserved_ips/$RESERVED_IP/actions. In the JSON body to the request, set the type attribute to on of the supported action types:

ActionDetails
assignAssigns a reserved IP to a Droplet
unassignUnassign a reserved IP from a Droplet
post/v2/reserved_ips/{reserved_ip}/actions

Path parameters

reserved_ipstring ipv4 required

A reserved IP address.

Request body

OR

Example request

{
  "droplet_id": 758604968
}

Response

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

Example response

{
  "action": {
    "id": 72531856,
    "status": "completed",
    "type": "assign_ip",
    "started_at": "2015-11-12T17:51:03Z",
    "completed_at": "2015-11-12T17:51:14Z",
    "resource_id": 758604968,
    "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",
    "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"
  }
}

Changes

Changed in 4 of the 8 revisions of this API.14