Allocate a new Agent VM

Allocates a VM from the pool or creates a new one for the requesting org

POST /compute/v1/vms/allocate

Allocate a new Agent VM

cURL

curl --request POST \
  --url https://compute.hexelstudio.com/compute/v1/vms/allocate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tier": "<string>"
}
'

201

{
  "endpoint": "<string>",
  "expires_at": "<string>",
  "skills_loaded": [
    "<string>"
  ],
  "state": "<string>",
  "tier": "<string>",
  "token": "<string>",
  "vm_id": "<string>",
  "ws_url": "<string>"
}

Authorizations

Authorization · string · header · required

STS access token. Obtain via POST https://sts.hexelstudio.com/token with X-API-Key header.

Body

application/json

Allocation parameters

tier · string · required

env · object

Show child attributes

metadata · object

Show child attributes

org_id · string

secure_runtime · string

skills · string[]

ttl_seconds · integer

Response

201

application/json

Created

endpoint · string

expires_at · string

skills_loaded · string[]

state · string

tier · string

token · string

vm_id · string

ws_url · string