API Reference
Instances
Execute Command
2min
PUT
PATH PARAMETERS
id
integer
*Example: 123456
ID of the instance to execute the command on
QUERY PARAMETERS
api_key
string
*Example: API-Key
BODY PARAMETERS
body
ExecuteCommandRequest
command
string
*Example: ls -l
The command to be executed on the instance
RESPONSES
200
Command executed successfully
ExecuteCommandResponse
success
boolean
Example: true
Indicates if the command execution was successful
writeable_path
string
Example: /var/lib/docker/overlay2/8fba59b398a458d65d7508dd9c5770a9656b709118bb8e7177ed047c29e7ae04/diff
The path where the command was executed on the instance
result_url
string
Example: https://s3.amazonaws.com/vast.ai/instance_logs/c919c0f806c7b084cc077e65832f9042C.log
The URL where the command execution result can be accessed
msg
string
Example: Command is executing, wait a few seconds and then view the result_url
Additional message regarding the command execution
Updated 20 Jul 2023
Did this page help you?