Skip to content

Issue

POST
/api/v1/api-keys
curl --request POST \
--url https://example.com/api/v1/api-keys \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "superuser": false }'
Media typeapplication/json
IssueAPIKeyRequest
object
name
required
Name
string
superuser
Superuser
boolean

Successful Response

Media typeapplication/json
IssuedAPIKey
object
id
required
Id
string
token
required
Token
string
Examplegenerated
{
"id": "example",
"token": "example"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}