DigitalOcean API (unofficial showcase)
GET/v2/images/{image_id}/actions/{action_id}

Retrieve an Existing Action

To retrieve the status of an image action, send a GET request to /v2/images/$IMAGE_ID/actions/$IMAGE_ACTION_ID.

2 parameters
image_idintegerrequired
A unique number that can be used to identify and reference a specific image.
action_idintegerrequired
A unique numeric ID that can be used to identify and reference an action.

6 status codes
200The response will be an object with a key called `action`. The value of this will be an object that contains the standard image action attributes.
idintegeroptional
A unique numeric ID that can be used to identify and reference an action.
statusstringoptional
The current status of the action. This can be "in-progress", "completed", or "errored".
Allowed:in-progresscompletederroredDefault:in-progress
typestringoptional
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.
started_atstringoptional
A time value given in ISO8601 combined date and time format that represents when the action was initiated.
completed_atstringoptional
A time value given in ISO8601 combined date and time format that represents when the action was completed.
resource_idintegeroptional
A unique identifier for the resource that the action is associated with.
resource_typestringoptional
The type of resource that the action is associated with.
regionobjectoptional
region_slugstringoptional
A human-readable string that is used as a unique identifier for each region.
401Authentication failed due to invalid credentials.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
404The resource was not found.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429The API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500There was a server error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultThere was an unexpected error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

Error handling

A 401 is returned: Authentication failed due to invalid credentials. A 404 is returned: The resource was not found. A 429 is returned: The API rate limit has been exceeded. A 500 is returned: There was a server error. Any other status is an error: There was an unexpected error.