Get Deployment

Returns the configuration and current version details for a single deployment by ID.

GET /api/v0/deployment/{id}/

Get Deployment

cURL

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

import requests

url = "https://console.vast.ai/api/v0/deployment/{id}/"

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/deployment/{id}/', 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/deployment/{id}/",
  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/deployment/{id}/"

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

require 'uri'
require 'net/http'

url = URI("https://console.vast.ai/api/v0/deployment/{id}/")

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

{
  "success": true,
  "deployment": {
    "id": 123,
    "name": "<string>",
    "tag": "<string>",
    "endpoint_id": 123,
    "endpoint_state": "<string>",
    "s3_key": "<string>",
    "env": "<string>",
    "image": "<string>",
    "storage": 123,
    "search_params": "<string>",
    "file_hash": "<string>",
    "current_version_id": 123,
    "last_healthy_version_id": 123,
    "ttl": 123,
    "last_client_heartbeat": 123,
    "created_at": 123,
    "updated_at": 123
  }
}

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

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

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Path Parameters

id · integer · required

Deployment ID

Response

200

application/json

Returns {success: true, deployment: {id, name, tag, endpoint_id, endpoint_state, s3_key, env, image, storage, search_params, file_hash, current_version_id, last_healthy_version_id, ttl, last_client_heartbeat, created_at, updated_at}}

success · boolean

Always true on success.

deployment · object

Show child attributes