Skip to main content

actions

Overview

Nameactions
TypeResource
Iddigitalocean.reserved_ips.actions

Fields

NameDatatypeDescription
idintegerA unique numeric ID that can be used to identify and reference an action.
completed_atstringA time value given in ISO8601 combined date and time format that represents when the action was completed.
regionobject
region_slugstringA human-readable string that is used as a unique identifier for each region.
resource_idintegerA unique identifier for the resource that the action is associated with.
resource_typestringThe type of resource that the action is associated with.
started_atstringA time value given in ISO8601 combined date and time format that represents when the action was initiated.
statusstringThe current status of the action. This can be "in-progress", "completed", or "errored".
typestringThis is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action.

Methods

NameAccessible byRequired ParamsDescription
reservedIPsActions_getSELECTaction_id, reserved_ipTo retrieve the status of a reserved IP action, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID.
reservedIPsActions_listSELECTreserved_ipTo retrieve all actions that have been executed on a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions.
reservedIPsActions_postINSERTreserved_ipTo 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:

| Action | Details
|------------|--------
| assign | Assigns a reserved IP to a Droplet
| unassign | Unassign a reserved IP from a Droplet
_reservedIPsActions_getEXECaction_id, reserved_ipTo retrieve the status of a reserved IP action, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions/$ACTION_ID.
_reservedIPsActions_listEXECreserved_ipTo retrieve all actions that have been executed on a reserved IP, send a GET request to /v2/reserved_ips/$RESERVED_IP/actions.