Skip to main content
POST
create api-key

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:
key_params
object

Optional wildcard parameters for advanced keys

Example:

Response

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

False when permissions are disabled

Example:

false