Create Instance

2min
PUT
Create an instance on which will show up on the Instances page of your account. This is the equivalent operation of clicking the 'rent' button on the create page.
PATH PARAMETERS
id
integer
*
ID of instance type to launch
QUERY PARAMETERS
api_key
string
*
Example: API-Key
BODY PARAMETERS
body
CreateInstanceRequest
*
Example: [object Object]
client_id
string
*
The client creating the instance. Use 'me' when trying to create on your own account.
image
string
*
Docker container image to launch
env
object
Example: [object Object]
Environment variables and port mapping options
price
number
Per machine bid price in $/hour
disk
number
*
Size of local disk partition in GB
label
string
Label to set on the instance
extra
string
onstart
string
Filename to use as onstart script
runtype
string
*
Type of instance to launch
image_login
string
Docker login arguments for private repo authentication
python_utf8
boolean
Workaround for images with locale problems set Python's locale to C.UTF-8
lang_utf8
boolean
Workaround for images with locale problems install and generate locales before instance launch, and set locale to C.UTF-8
use_jupyter_lab
boolean
For runtype 'jupyter', launch instance with Jupyter Lab
jupyter_dir
string
For runtype 'jupyter', directory in instance to use to launch Jupyter
create_from
string
Existing instance ID to use as a basis for the new instance
force
boolean
Skip sanity checks when creating from an existing instance
RESPONSES
200
Created Instance
CreateInstanceResponse
success
boolean
Indicates if the instance creation was successful
new_contract
integer
ID of the new contract
﻿
﻿
Updated 20 Jul 2023
Did this page help you?
Vast.ai Docs

Create Instance
