Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
Provider

Terminate spot workloads running on a node your org owns

Reclaims capacity by terminating the spot workloads on one of your nodes. Scoped strictly to workloads bought at the spot tier: a spot instance is sold on the explicit contract that the capacity owner can terminate it at any time. Non-spot workloads on the node are never touched. Every termination is audited and the affected VM records capacity reclaim as its reason, so the customer is not told it was a platform fault.

POST
/v1/orgs/{orgId}/provider/nodes/{nodeId}/reclaim-spot
AuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer vl_….

In: header

Path Parameters

orgId*string
nodeId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/orgs/string/provider/nodes/string/reclaim-spot" \  -H "Content-Type: application/json" \  -d '{}'
{
  "terminated": [
    "string"
  ],
  "skipped": [
    "string"
  ]
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}

Command line

The orl CLI wraps this endpoint:

orl provider spot-workload reclaim <node-id>