Skip to main content
GET
/
api
/
public
/
v1
/
vms
/
{id}
/
actions
/
{actionId}
Get a single VM action
curl --request GET \
  --url https://api.vmarea.com/api/v1/api/public/v1/vms/{id}/actions/{actionId} \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "data": {
    "id": "<string>",
    "action": "<string>",
    "status": "<string>",
    "error": "<string>",
    "startedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

Long-lived API token created at https://vmarea.com/dashboard/settings/api-keys. Tokens are scope-restricted; this spec lists the scope each endpoint requires.

Path Parameters

​
id
string
required
​
actionId
string
required

Response

Default Response

​
success
enum<boolean>
required
Available options:
true
​
data
object
required