create api-key

Creates a new API key with specified permissions for the authenticated user.

CLI Usage: vastai create api-key --name <name> --permission_file <permissions_file> [--key_params <params>]

POST /api/v0/auth/apikeys

create api-key

cURL

curl --request POST \
  --url https://console.vast.ai/api/v0/auth/apikeys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "read-only-key",
  "permissions": {
    "read": true,
    "write": false
  },
  "key_params": {
    "ip_whitelist": [
      "1.2.3.4"
    ]
  }
}
'

import requests

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

payload = {
    "name": "read-only-key",
    "permissions": {
        "read": True,
        "write": False
    },
    "key_params": { "ip_whitelist": ["1.2.3.4"] }
}
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({
    name: 'read-only-key',
    permissions: {read: true, write: false},
    key_params: {ip_whitelist: ['1.2.3.4']}
  })
};

fetch('https://console.vast.ai/api/v0/auth/apikeys', 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/auth/apikeys",
  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([
    'name' => 'read-only-key',
    'permissions' => [
        'read' => true,
        'write' => false
    ],
    'key_params' => [
        'ip_whitelist' => [
                '1.2.3.4'
        ]
    ]
  ]),
  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/auth/apikeys"

	payload := strings.NewReader("{\n  \"name\": \"read-only-key\",\n  \"permissions\": {\n    \"read\": true,\n    \"write\": false\n  },\n  \"key_params\": {\n    \"ip_whitelist\": [\n      \"1.2.3.4\"\n    ]\n  }\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/auth/apikeys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"read-only-key\",\n  \"permissions\": {\n    \"read\": true,\n    \"write\": false\n  },\n  \"key_params\": {\n    \"ip_whitelist\": [\n      \"1.2.3.4\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"read-only-key\",\n  \"permissions\": {\n    \"read\": true,\n    \"write\": false\n  },\n  \"key_params\": {\n    \"ip_whitelist\": [\n      \"1.2.3.4\"\n    ]\n  }\n}"

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

200

{
  "id": 12345,
  "key": "vast-123456789abcdef",
  "permissions": false
}

{
  "success": false,
  "msg": "Invalid permission format"
}

{
  "success": false,
  "msg": "Unauthorized"
}

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

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Body

application/json

name · string · required

Name for the API key

Example:

"read-only-key"

permissions · object

JSON object containing permission definitions

Example:

{ "read": true, "write": false }

key_params · object

Optional wildcard parameters for advanced keys

Example:

{ "ip_whitelist": ["1.2.3.4"] }

Response

200

application/json

API key created successfully

id · integer

The ID of the created API key

Example:

12345

key · string

The newly generated API key

Example:

"vast-123456789abcdef"

permissions · boolean object

False when permissions are disabled

Example:

false