execute

Executes a constrained remote command on a specified instance. The command output can be retrieved from the returned result URL.

CLI Usage: vastai execute <instance_id> <command>

PUT /api/v0/instances/command/{id}

execute

cURL

curl --request PUT \
  --url https://console.vast.ai/api/v0/instances/command/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "ls -l"
}
'

import requests

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

payload = { "command": "ls -l" }
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({command: 'ls -l'})
};

fetch('https://console.vast.ai/api/v0/instances/command/{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/instances/command/{id}",
  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([
    'command' => 'ls -l'
  ]),
  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/instances/command/{id}"

	payload := strings.NewReader("{\n  \"command\": \"ls -l\"\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/instances/command/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"ls -l\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"command\": \"ls -l\"\n}"

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

200

{
  "success": true,
  "writeable_path": "/workspace",
  "result_url": "https://s3.amazonaws.com/vast.ai/instance_logs/abc123.log",
  "msg": "Command is executing, wait a few seconds and then view the result_url"
}

{
  "success": false,
  "msg": "Invalid command given."
}

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

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

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

{
  "success": false,
  "error": "invalid_args",
  "msg": "Invalid json_body"
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Path Parameters

id · integer · required

ID of the instance to execute command on

Example:

12345

Body

application/json

command · string · required

Command to execute on the instance

Maximum string length: 512

Example:

"ls -l"

Response

200

application/json

Command queued successfully

success · boolean

Example:

true

writeable_path · string

Container writeable path

Example:

"/workspace"

result_url · string

URL to fetch command execution results

Example:

"https://s3.amazonaws.com/vast.ai/instance_logs/abc123.log"

msg · string

Example:

"Command is executing, wait a few seconds and then view the result_url"