WarpBuild LogoWarpBuild Docs
Runners

PATCH /runners/{id}

Updates an existing runner set configuration. Only the fields specified in the request body will be updated; all other fields remain unchanged. You can update various aspects of a runner including its name, labels, storage configuration, and capacity type.

PATCH
/runners/{id}

Authorization

Authorization<token>

In: header

Path Parameters

id*string

Runner ID

Request Body

application/json

update runner body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X PATCH "https://example.com/runners/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "active": true,  "configuration": {    "byoc_sku": {      "arch": "x64",      "imdsv2_required": true,      "instance_types": [        "m5.xlarge",        "m5.2xlarge"      ],      "is_public": false,      "network_tier": "STANDARD",      "role_arn": "arn:aws:iam::123456789012:role/WarpBuildRole"    },    "capacity_type": "ondemand",    "image": "ubuntu-2404",    "sku": "warp-ubuntu-2404-x64-4x",    "storage": {      "disk_type": "pd-balanced",      "iops": 0,      "performance_tier": "P15",      "size": 0,      "throughput": 0,      "tier": "low"    }  },  "created_at": "string",  "id": "runner_abc123",  "labels": [    "warp-ubuntu-2404-x64-4x"  ],  "meta": {},  "name": "my-ubuntu-runner",  "organization_id": "org_abc123",  "provider_id": "cloud_xyz789",  "stock_runner_id": "stock_xyz",  "updated_at": "string",  "vcs_integration_id": "vcs_abc123"}