Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vast.ai/llms.txt

Use this file to discover all available pages before exploring further.

Create a new api-key with restricted permissions. Can be sent to other users and teammates

​
Usage

vastai create api-key --name NAME --permission_file PERMISSIONS

​
Options

​
--name
string
name of the api-key
​
--permission_file
string
file path for json encoded permissions, see https://vast.ai/docs/cli/roles-and-permissions for more information
​
--key_params
string
optional wildcard key params for advanced keys

​
Description

In order to create api keys you must understand how permissions must be sent via json format. You can find more information about permissions here: https://vast.ai/docs/cli/roles-and-permissions

​
Examples

vastai create api-key

​
Global Options

The following options are available for all commands:
OptionDescription
--url URLServer REST API URL
--retry NRetry limit
--rawOutput machine-readable JSON
--explainVerbose explanation of API calls
--api-key KEYAPI key (defaults to ~/.config/vastai/vast_api_key)