Schedule Machine Maintenance

Schedules a maintenance window for a single machine and sends downtime warning emails to affected instance clients and a confirmation to the host.

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

Schedule Machine Maintenance

cURL

curl --request PUT \
  --url https://console.vast.ai/api/v0/machines/{machine_id}/dnotify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sdate": "2023-10-30T14:00:00Z",
  "duration": 2,
  "maintenance_reason": "Routine hardware check",
  "maintenance_category": "software"
}
'

import requests

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

payload = {
    "sdate": "2023-10-30T14:00:00Z",
    "duration": 2,
    "maintenance_reason": "Routine hardware check",
    "maintenance_category": "software"
}
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({
    sdate: '2023-10-30T14:00:00Z',
    duration: 2,
    maintenance_reason: 'Routine hardware check',
    maintenance_category: 'software'
  })
};

fetch('https://console.vast.ai/api/v0/machines/{machine_id}/dnotify', 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}/dnotify",
  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([
    'sdate' => '2023-10-30T14:00:00Z',
    'duration' => 2,
    'maintenance_reason' => 'Routine hardware check',
    'maintenance_category' => 'software'
  ]),
  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/machines/{machine_id}/dnotify"

	payload := strings.NewReader("{\n  \"sdate\": \"2023-10-30T14:00:00Z\",\n  \"duration\": 2,\n  \"maintenance_reason\": \"Routine hardware check\",\n  \"maintenance_category\": \"software\"\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/machines/{machine_id}/dnotify")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sdate\": \"2023-10-30T14:00:00Z\",\n  \"duration\": 2,\n  \"maintenance_reason\": \"Routine hardware check\",\n  \"maintenance_category\": \"software\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"sdate\": \"2023-10-30T14:00:00Z\",\n  \"duration\": 2,\n  \"maintenance_reason\": \"Routine hardware check\",\n  \"maintenance_category\": \"software\"\n}"

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

200

{
  "success": true,
  "machine_id": 1001,
  "notifications_sent": 3,
  "you_sent": "3 notifications sent"
}

{
  "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 to schedule maintenance for.

Body

application/json

sdate · string<date-time> · required

Start date and time of the maintenance window.

Example:

"2023-10-30T14:00:00Z"

duration · integer · required

Duration of the maintenance window in hours.

Example:

2

maintenance_reason · string

Reason for the maintenance.

Example:

"Routine hardware check"

maintenance_category · enum<string>

Category of the maintenance.

Available options: power, internet, disk, gpu, software, other

Example:

"software"

Response

200

application/json

{success: true, machine_id, notifications_sent, you_sent: "N notifications sent"} on success.

success · boolean

true on success

machine_id · integer

ID of the machine scheduled for maintenance

notifications_sent · integer

Number of client notification emails sent

you_sent · string

Human-readable summary of notifications sent