Update Current User

Update profile fields (SSH key, email, password, payout settings, etc.) for the authenticated user.

PUT /api/v0/users/

Update Current User

cURL

curl --request PUT \
  --url https://console.vast.ai/api/v0/users/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "normalized_email": "[e-mail]",
  "username": "johndoe",
  "fullname": "John Doe"
}
'

import requests

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

payload = {
    "normalized_email": "[e-mail]",
    "username": "johndoe",
    "fullname": "John Doe"
}
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({
    normalized_email: '[e-mail]',
    username: 'johndoe',
    fullname: 'John Doe'
  })
};

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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'normalized_email' => '[e-mail]',
    'username' => 'johndoe',
    'fullname' => 'John Doe'
  ]),
  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  \"normalized_email\": \"[e-mail]\",\n  \"username\": \"johndoe\",\n  \"fullname\": \"John Doe\"\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/users/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"normalized_email\": \"[e-mail]\",\n  \"username\": \"johndoe\",\n  \"fullname\": \"John Doe\"\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::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"normalized_email\": \"[e-mail]\",\n  \"username\": \"johndoe\",\n  \"fullname\": \"John Doe\"\n}"

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

200

{
  "id": 123,
  "username": "<string>",
  "email": "<string>",
  "ssh_key": "<string>",
  "balance": 123,
  "email_verified": true,
  "huggingface_cloud_sync_enabled": true,
  "paypal_email": "<string>",
  "wise_email": "<string>",
  "has_payout": true
}

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

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

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Body

application/json

normalized_email · string

Normalized email address.

Example:

"[e-mail]"

username · string

Username of the user.

Example:

"johndoe"

fullname · string

Full name of the user.

Example:

"John Doe"

Response

200

application/json

Updated user object returned

id · integer

User ID

username · string

Username

email · string

Email address

ssh_key · string

Default SSH public key

balance · number

Account credit balance (USD)

email_verified · boolean

Whether the email has been verified

huggingface_cloud_sync_enabled · boolean

Whether Hugging Face cloud sync is currently enabled for this authenticated user

paypal_email · string

PayPal payout email

wise_email · string

Wise payout email

has_payout · boolean

Whether a payout method is configured