list volumes

Retrieve information about all volumes rented by you.

CLI Usage: vastai show volumes

GET /api/v0/volumes/

list volumes

cURL

curl --request GET \
  --url https://console.vast.ai/api/v0/volumes/ \
  --header 'Authorization: Bearer <token>'

import requests

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

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

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

print(response.text)

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

fetch('https://console.vast.ai/api/v0/volumes/', 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/volumes/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/volumes/"

	req, _ := http.NewRequest("GET", 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.get("https://console.vast.ai/api/v0/volumes/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

200

{
  "volumes": [
    {
      "instances": [
        {}
      ],
      "driver_version": "<string>",
      "cuda_max_good": 123,
      "machine_id": 123,
      "public_ipaddr": "<string>",
      "reliability2": 123,
      "host_id": 123,
      "cpu_name": "<string>",
      "mobo_name": "<string>",
      "disk_space": 123,
      "disk_name": "<string>",
      "inet_up": 123,
      "inet_down": 123,
      "storage_total_cost": 123,
      "os_version": "<string>",
      "verification": "<string>",
      "static_ip": true,
      "cpu_arch": "<string>",
      "start_date": 123,
      "id": 123,
      "status": "<string>"
    }
  ]
}

{
  "detail": "Authentication credentials were not provided."
}

{
  "detail": "API requests too frequent endpoint threshold=5.5"
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Response

200

application/json

Success response

volumes · object[]

Show child attributes