create subaccount

Creates either a standalone user account or a subaccount under a parent account. Subaccounts can be restricted to host-only functionality.

CLI Usage: vastai create subaccount --email <email> --username <username> --password <password> [--type host]

POST /api/v0/users

create subaccount

cURL

curl --request POST \
  --url https://console.vast.ai/api/v0/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[e-mail]",
  "username": "testuser123",
  "password": "securepass123",
  "host_only": true,
  "parent_id": "me",
  "ssh_key": "<string>",
  "captcha": "<string>"
}
'

import requests

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

payload = {
    "email": "[e-mail]",
    "username": "testuser123",
    "password": "securepass123",
    "host_only": True,
    "parent_id": "me",
    "ssh_key": "<string>",
    "captcha": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: '[e-mail]',
    username: 'testuser123',
    password: 'securepass123',
    host_only: true,
    parent_id: 'me',
    ssh_key: '<string>',
    captcha: '<string>'
  })
};

fetch('https://console.vast.ai/api/v0/users', 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/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '[e-mail]',
    'username' => 'testuser123',
    'password' => 'securepass123',
    'host_only' => true,
    'parent_id' => 'me',
    'ssh_key' => '<string>',
    'captcha' => '<string>'
  ]),
  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/users"

	payload := strings.NewReader("{\n  \"email\": \"[e-mail]\",\n  \"username\": \"testuser123\",\n  \"password\": \"securepass123\",\n  \"host_only\": true,\n  \"parent_id\": \"me\",\n  \"ssh_key\": \"<string>\",\n  \"captcha\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://console.vast.ai/api/v0/users")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"[e-mail]\",\n  \"username\": \"testuser123\",\n  \"password\": \"securepass123\",\n  \"host_only\": true,\n  \"parent_id\": \"me\",\n  \"ssh_key\": \"<string>\",\n  \"captcha\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"[e-mail]\",\n  \"username\": \"testuser123\",\n  \"password\": \"securepass123\",\n  \"host_only\": true,\n  \"parent_id\": \"me\",\n  \"ssh_key\": \"<string>\",\n  \"captcha\": \"<string>\"\n}"

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

200

{
  "id": 12345,
  "username": "testuser",
  "email": "[e-mail]",
  "key_id": 67890
}

{
  "error": "invalid_email",
  "msg": "Email address not allowed"
}

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

{
  "error": "user_exists",
  "msg": "user already exists."
}

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

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Body

application/json

email · string · required

User's email address

Maximum string length: 64

Pattern: ^(?!.*@vast)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

Example:

"[e-mail]"

username · string · required

Desired username

Maximum string length: 64

Example:

"testuser123"

password · string · required

Account password

Maximum string length: 256

Example:

"securepass123"

host_only · boolean

If true, account is restricted to host functionality only

Example:

true

parent_id · string

Parent account ID for subaccounts. Use "me" for current user.

Example:

"me"

ssh_key · string

Optional SSH public key

Maximum string length: 4096

captcha · string

Captcha token (required for non-subaccounts)

Maximum string length: 8192

Response

200

application/json

Account created successfully

id · integer

User ID

username · string

email · string

key_id · integer

API key for the new account