Delete Deployments by Name

Soft-deletes all deployments matching the given name (and optionally tag), cascading to endpoints and workers.

DELETE /api/v0/deployments/

Delete Deployments by Name

cURL

curl --request DELETE \
  --url https://console.vast.ai/api/v0/deployments/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-model",
  "tag": "v2"
}
'

import requests

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

payload = {
    "name": "my-model",
    "tag": "v2"
}
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({name: 'my-model', tag: 'v2'})
};

fetch('https://console.vast.ai/api/v0/deployments/', 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/deployments/",
  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([
    'name' => 'my-model',
    'tag' => 'v2'
  ]),
  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/deployments/"

	payload := strings.NewReader("{\n  \"name\": \"my-model\",\n  \"tag\": \"v2\"\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/deployments/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"my-model\",\n  \"tag\": \"v2\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"my-model\",\n  \"tag\": \"v2\"\n}"

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

200

{
  "success": true,
  "count": 2
}

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

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

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Body

application/json

name · string

Name of the deployment(s) to delete; required.

Example:

"my-model"

tag · string

Tag variant to restrict deletion to a single deployment; if omitted, all tags under the name are deleted.

Example:

"v2"

Response

200

application/json

Returns {success: true, count: <number_deleted>}

success · boolean

Always true on success.

count · integer

Number of deployments deleted.