Generate API Key
POST/api/apikey/generate
Generates a long-term API Key from your account's username and password.
Request​
- application/json
Body
required
Your account username.
Your account password.
A human readable name for your API key used to identify it when managing keys.
Responses​
- 200
- 400
- 401
- 403
- application/json
- Schema
- Example (from schema)
Schema
The API key. Will be null
unless the key was created during the request. Keys are not stored in plaintext and can not be recovered after creation time.
The date that the API key was created.
The date that the API key will automatically expire.
The last time that the API key was used to authenticate with the API.
The database ID for the API key. Used when deleting keys.
The human-readable name for the API key used for managing keys.
The non-secret key prefix.
The non-secret key suffix. Helpful for identifying keys if a name wasn't specified at creation time.
{
"api_key": "string",
"date_created": "2024-10-31T19:26:03.489Z",
"date_expires": "2024-10-31T19:26:03.489Z",
"date_last_used": "2024-10-31T19:26:03.489Z",
"id": "string",
"name": "string",
"prefix": "string",
"suffix": "string"
}
- application/json
- Schema
- Example (from schema)
Schema
Default value: Value Error.
{
"error": "string",
"message": "Value Error."
}
- application/json
- Schema
- Example (from schema)
Schema
Default value: Invalid username or password
{
"username": "string",
"message": "Invalid username or password"
}
- application/json
- Schema
- Example (from schema)
Schema
Default value: Invalid username or password
{
"username": "string",
"message": "Invalid username or password"
}