Skip to main content
POST
/
runners
/
{runner_id}
/
drain
cURL
curl --request POST \
  --url https://api.example.com/runners/{runner_id}/drain
{
  "capabilities": {
    "cpu_cores": 1,
    "gpu_available": true,
    "max_concurrent_jobs": 1,
    "memory_gb": 123,
    "supported_simulation_types": [
      "<string>"
    ],
    "python_version": "<string>"
  },
  "current_jobs": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "id": "<string>",
  "last_heartbeat": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "registered_at": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ],
  "total_jobs_completed": 1,
  "total_jobs_failed": 1,
  "accepting_jobs": true,
  "drain_reason": "<string>"
}

Path Parameters

​
runner_id
string
required

Runner identifier

Response

Drain a runner from new work

​
capabilities
object
required
​
current_jobs
string<uuid>[]
required
​
id
string
required
​
last_heartbeat
string<date-time>
required
​
name
string
required
​
registered_at
string<date-time>
required
​
status
enum<string>
required
Available options:
Idle,
Busy,
Offline,
Maintenance
​
tags
string[]
required
​
total_jobs_completed
integer<int64>
required
Required range: x >= 0
​
total_jobs_failed
integer<int64>
required
Required range: x >= 0
​
accepting_jobs
boolean
​
drain_reason
string | null