Update Autojob Workergroup

Updates scaling parameters, template, search params, or launch args on an existing workergroup for the authenticated user.

PUT /api/v0/autojobs/{id}/

Update Autojob Workergroup

cURL

curl --request PUT \
  --url https://console.vast.ai/api/v0/autojobs/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "min_load": 0.2,
  "target_util": 0.85,
  "cold_mult": 2.5,
  "test_workers": 2,
  "template_hash": "def456",
  "template_id": 100,
  "launch_args": "<string>",
  "gpu_ram": 24,
  "endpoint_id": 42,
  "search_params": "gpu_ram>=24"
}
'

import requests

url = "https://console.vast.ai/api/v0/autojobs/{id}/"

payload = {
    "min_load": 0.2,
    "target_util": 0.85,
    "cold_mult": 2.5,
    "test_workers": 2,
    "template_hash": "def456",
    "template_id": 100,
    "launch_args": "<string>",
    "gpu_ram": 24,
    "endpoint_id": 42,
    "search_params": "gpu_ram>=24"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    min_load: 0.2,
    target_util: 0.85,
    cold_mult: 2.5,
    test_workers: 2,
    template_hash: 'def456',
    template_id: 100,
    launch_args: '<string>',
    gpu_ram: 24,
    endpoint_id: 42,
    search_params: 'gpu_ram>=24'
  })
};

fetch('https://console.vast.ai/api/v0/autojobs/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://console.vast.ai/api/v0/autojobs/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'min_load' => 0.2,
    'target_util' => 0.85,
    'cold_mult' => 2.5,
    'test_workers' => 2,
    'template_hash' => 'def456',
    'template_id' => 100,
    'launch_args' => '<string>',
    'gpu_ram' => 24,
    'endpoint_id' => 42,
    'search_params' => 'gpu_ram>=24'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://console.vast.ai/api/v0/autojobs/{id}/"

	payload := strings.NewReader("{\n  \"min_load\": 0.2,\n  \"target_util\": 0.85,\n  \"cold_mult\": 2.5,\n  \"test_workers\": 2,\n  \"template_hash\": \"def456\",\n  \"template_id\": 100,\n  \"launch_args\": \"<string>\",\n  \"gpu_ram\": 24,\n  \"endpoint_id\": 42,\n  \"search_params\": \"gpu_ram>=24\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://console.vast.ai/api/v0/autojobs/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"min_load\": 0.2,\n  \"target_util\": 0.85,\n  \"cold_mult\": 2.5,\n  \"test_workers\": 2,\n  \"template_hash\": \"def456\",\n  \"template_id\": 100,\n  \"launch_args\": \"<string>\",\n  \"gpu_ram\": 24,\n  \"endpoint_id\": 42,\n  \"search_params\": \"gpu_ram>=24\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.vast.ai/api/v0/autojobs/{id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"min_load\": 0.2,\n  \"target_util\": 0.85,\n  \"cold_mult\": 2.5,\n  \"test_workers\": 2,\n  \"template_hash\": \"def456\",\n  \"template_id\": 100,\n  \"launch_args\": \"<string>\",\n  \"gpu_ram\": 24,\n  \"endpoint_id\": 42,\n  \"search_params\": \"gpu_ram>=24\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "success": true
}

{
  "error": "<string>",
  "msg": "<string>"
}

{
  "error": "<string>",
  "msg": "<string>"
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Path Parameters

id · integer · required

Numeric ID of the workergroup to update.

Body

application/json

min_load · number

Updated minimum load threshold for this workergroup.

Example:

0.2

target_util · number

Updated target utilization ratio (0-1).

Example:

0.85

cold_mult · number

Updated cold-standby multiplier.

Example:

2.5

test_workers · integer

Updated number of test/canary workers.

Example:

2

template_hash · string

Hash ID of a new template to switch to.

Example:

"def456"

template_id · integer

Numeric ID of a new template to switch to.

Example:

100

launch_args · string

Updated launch arguments for worker instances.

gpu_ram · number

Updated minimum GPU RAM in GB.

Example:

24

endpoint_id · integer

ID of the endpoint this workergroup belongs to; required.

Example:

42

search_params · string

Updated GPU offer filter expression.

Example:

"gpu_ram>=24"

Response

200

application/json

Returns {success: true}

success · boolean

Always true on success.