actions

Creates, updates, deletes, gets or lists an actions resource.

Overview

Name	actions
Type	Resource
Id	digitalocean.account.actions

Fields

The following fields are returned by SELECT queries:

actions_get

The result will be a JSON object with an action key. This will be set to an action object containing the standard action attributes.

Name	Datatype	Description
id	integer	A unique numeric ID that can be used to identify and reference an action.
resource_id	integer	A unique identifier for the resource that the action is associated with.
completed_at	string (date-time)	A time value given in ISO8601 combined date and time format that represents when the action was completed. (example: 2020-11-14T16:30:06Z)
region	object
region_slug	string	A human-readable string that is used as a unique identifier for each region. (example: nyc3)
resource_type	string	The type of resource that the action is associated with. (example: droplet)
started_at	string (date-time)	A time value given in ISO8601 combined date and time format that represents when the action was initiated. (example: 2020-11-14T16:29:21Z)
status	string	The current status of the action. This can be "in-progress", "completed", or "errored". (example: completed, default: in-progress)
type	string	This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. (example: create)

actions_list

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 action attributes

Name	Datatype	Description
id	integer	A unique numeric ID that can be used to identify and reference an action.
resource_id	integer	A unique identifier for the resource that the action is associated with.
completed_at	string (date-time)	A time value given in ISO8601 combined date and time format that represents when the action was completed. (example: 2020-11-14T16:30:06Z)
region	object
region_slug	string	A human-readable string that is used as a unique identifier for each region. (example: nyc3)
resource_type	string	The type of resource that the action is associated with. (example: droplet)
started_at	string (date-time)	A time value given in ISO8601 combined date and time format that represents when the action was initiated. (example: 2020-11-14T16:29:21Z)
status	string	The current status of the action. This can be "in-progress", "completed", or "errored". (example: completed, default: in-progress)
type	string	This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. (example: create)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
actions_get	select	action_id		To retrieve a specific action object, send a GET request to /v2/actions/$ACTION_ID.
actions_list	select		per_page, page	This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
action_id	integer	A unique numeric ID that can be used to identify and reference an action. (example: 36804636)
page	integer	Which 'page' of paginated results to return. (example: 1)
per_page	integer	Number of items returned per page (example: 2)

SELECT examples

actions_get

To retrieve a specific action object, send a GET request to /v2/actions/$ACTION_ID.

SELECT
id,
resource_id,
completed_at,
region,
region_slug,
resource_type,
started_at,
status,
type
FROM digitalocean.account.actions
WHERE action_id = '{{ action_id }}' -- required;

actions_list

This will be the entire list of actions taken on your account, so it will be quite large. As with any large collection returned by the API, the results will be paginated with only 20 on each page by default.

SELECT
id,
resource_id,
completed_at,
region,
region_slug,
resource_type,
started_at,
status,
type
FROM digitalocean.account.actions
WHERE per_page = '{{ per_page }}'
AND page = '{{ page }}';