v1

latestOpenAPI 3.1.02026-07-13897404.3 KB

Serverless

update workergroup

Updates the properties of an existing workergroup based on the provided parameters.

CLI Usage: vastai update workergroup <id> [options]

put/api/v0/workergroups/{id}/

Path parameters

idinteger required

Example:4242

The ID of the workergroup to update.

Request body

min_loadnumber

Minimum load for the workergroup.

target_utilnumber

Target utilization for the workergroup.

cold_multnumber

Cold multiplier for the workergroup.

test_workersinteger

Number of test workers for performance estimation.

template_hashstring

Template hash for the workergroup.

template_idinteger

Template ID for the workergroup.

search_paramsstring

Search parameters for offers (JSON object or query string).

launch_argsstring

Launch arguments for creating instances.

gpu_ramnumber

Estimated GPU RAM requirement.

endpoint_namestring

Deployment endpoint name.

endpoint_idinteger

Deployment endpoint ID.

Example request

{
  "min_load": 1,
  "target_util": 0.9,
  "cold_mult": 3,
  "test_workers": 3,
  "template_hash": "abc123def456",
  "template_id": 456,
  "search_params": "gpu_name=RTX_3090 rentable=true",
  "launch_args": "--env VAR=value",
  "gpu_ram": 24,
  "endpoint_name": "vLLM-Qwen3-8B",
  "endpoint_id": 123
}

Response

Successfully updated the workergroup.

successboolean

Example response

{
  "success": true
}