Skip to content
Odinex Cloud
API reference

Actions

GET
/actions

Authorization

headerAuthorizationBearer <token>

Query Parameters

page?integer
Range1 <= value
Default1
per_page?integer
Range1 <= value <= 50
Default25
status?string
Value in"running""success""error"
resource_type?string

Only actions on this resource type (with resource_id)

resource_id?integer
Formatint64

Response Body

Actions, newest first

application/json
  1. response
actions*array<>
meta*
curl -X GET "https://example.com/actions"
{  "actions": [    {      "id": 0,      "command": "create_server",      "status": "running",      "progress": 0,      "started": "2019-08-24T14:15:22Z",      "finished": "2019-08-24T14:15:22Z",      "resources": [        {          "id": 0,          "type": "server"        }      ],      "error": {        "code": "string",        "message": "string"      }    }  ],  "meta": {    "pagination": {      "page": 0,      "per_page": 0,      "previous_page": 0,      "next_page": 0,      "last_page": 0,      "total_entries": 0    }  }}

Get action

GET
/actions/{id}

Authorization

headerAuthorizationBearer <token>

Path Parameters

id*integer
Formatint64

Response Body

Action

application/json
  1. response
action*
curl -X GET "https://example.com/actions/0"
{  "action": {    "id": 0,    "command": "create_server",    "status": "running",    "progress": 0,    "started": "2019-08-24T14:15:22Z",    "finished": "2019-08-24T14:15:22Z",    "resources": [      {        "id": 0,        "type": "server"      }    ],    "error": {      "code": "string",      "message": "string"    }  }}