cancel sync

Cancels an in-progress remote sync operation identified by the destination instance ID. This operation cannot be resumed once canceled and must be restarted if needed.

CLI Usage: vastai cancel sync --dst_id <destination_id>

DELETE /api/v0/commands/rclone

cancel sync

cURL

curl --request DELETE \
  --url https://console.vast.ai/api/v0/commands/rclone \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "dst_id": 123
}'

import requests

url = "https://console.vast.ai/api/v0/commands/rclone"

payload = { "dst_id": 123 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({dst_id: 123})
};

fetch('https://console.vast.ai/api/v0/commands/rclone', 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/commands/rclone",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'dst_id' => 123
  ]),
  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/commands/rclone"

	payload := strings.NewReader("{\n  \"dst_id\": 123\n}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://console.vast.ai/api/v0/commands/rclone")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dst_id\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.vast.ai/api/v0/commands/rclone")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dst_id\": 123\n}"

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

200

{
  "success": true,
  "msg": "Remote copy canceled - check instance status bar for progress updates (~30 seconds delayed)."
}

{
  "success": false,
  "error": "invalid_args",
  "msg": "Invalid dst_id."
}

{
  "success": false,
  "error": "no_such_instance",
  "msg": "No such instance."
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Body

application/json

dst_id · integer · required

The destination instance ID of the sync operation to cancel.

Response

200

application/json

Sync operation canceled successfully.

success · boolean

Example:

true

msg · string

Example:

"Remote copy canceled - check instance status bar for progress updates (~30 seconds delayed)."