Cleanup Machine Expired Contracts

Sends a volume cleanup task to the machine daemon and soft-deletes expired client contracts on the machine.

PUT /api/v0/machines/{machine_id}/cleanup

Cleanup Machine Expired Contracts

cURL

curl --request PUT \
  --url https://console.vast.ai/api/v0/machines/{machine_id}/cleanup \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://console.vast.ai/api/v0/machines/{machine_id}/cleanup"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};

fetch('https://console.vast.ai/api/v0/machines/{machine_id}/cleanup', 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/machines/{machine_id}/cleanup",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://console.vast.ai/api/v0/machines/{machine_id}/cleanup"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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/machines/{machine_id}/cleanup")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.vast.ai/api/v0/machines/{machine_id}/cleanup")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "success": true,
  "ctime": 1718000000,
  "machine_id": 12345,
  "user_id": 9876,
  "num_deleted": 5,
  "msg": "deleted 5 expired contracts on machine 12345"
}

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

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

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

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Path Parameters

machine_id · integer · required

ID of the machine on which expired contracts should be cleaned up.

Response

200

application/json

Returns {success: true, ctime, machine_id, user_id, num_deleted, msg} when contracts were deleted; {success: false, msg: "No expired contracts to delete"} when nothing to clean

success · boolean

Whether any contracts were deleted

ctime · number

Unix timestamp when cleanup ran

machine_id · integer

ID of the cleaned machine

user_id · integer

ID of the authenticated user

num_deleted · integer

Number of expired contracts removed

msg · string

Human-readable summary of the operation