Release Agent VM

POST/compute/v1/vms/{id}/release

Path parameters

idstring

VM ID (UUID)

Headers

Authorizationstring

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

Body parameters

Release options

recycleoptional boolean

Returns

200OKAgentVM

allocated_atoptional string

created_atoptional string

expires_atoptional string

idoptional string

metadataoptional map[string]

released_atoptional string

skillsoptional array of string

stateoptional string

tieroptional string

tokenoptional string

ttl_secondsoptional integer

Errors

404Not Found

curl --request POST \ --url 'https://compute.hexelstudio.com/compute/v1/vms/{id}/release' \ --header "Authorization: Bearer $ACCESS_TOKEN" \ --header 'Content-Type: application/json' \ --data '{ "recycle": true }'

const res = await fetch("https://compute.hexelstudio.com/compute/v1/vms/{id}/release", { method: "POST", headers: { Authorization: `Bearer ${process.env.ACCESS_TOKEN}`, "Content-Type": "application/json", }, body: JSON.stringify({ "recycle": true }), }) const data = await res.json()

import os import requests res = requests.post( "https://compute.hexelstudio.com/compute/v1/vms/{id}/release", headers={"Authorization": f"Bearer {os.environ['ACCESS_TOKEN']}"}, json={ "recycle": True, }, ) data = res.json()

{ "allocated_at": "2026-01-01T00:00:00Z", "created_at": "2026-01-01T00:00:00Z", "expires_at": "2026-01-01T00:00:00Z", "id": "string", "metadata": { "key": "string" }, "released_at": "2026-01-01T00:00:00Z", "skills": [ "string" ], "state": "string", "tier": "string", "token": "string", "ttl_seconds": 0 }