Skip to main content
POST
/
v1
/
regions
/
{region}
/
infrastructure
/
servers
/
actions
Batch server action
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({action: 'provision', ids: ['<string>'], params: {}})
};

fetch('https://api.example.com/v1/regions/{region}/infrastructure/servers/actions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "success": true,
  "data": {
    "action": "<string>",
    "serverCount": 123,
    "results": [
      {
        "serverId": "<string>",
        "status": "accepted",
        "reason": "<string>"
      }
    ]
  }
}

Path Parameters

region
string
required

Region identifier

Body

application/json
action
enum<string>
required

Action to perform

Available options:
provision,
validate,
start,
stop,
restart,
decommission
ids
string[]
required

Server IDs to act on

params
object

Action-specific parameters

Response

200 - application/json

Batch action initiated

success
enum<boolean>
Available options:
true
data
object