API by router
Settings
Get Settings
Get current user's settings - profile and API keys. "I'm not even supposed to be here today." - Dante, Clerks
AuthorizationBearer <token>
In: header
Response Body
curl -X GET "https://loading/v1/settings"{
"api_keys": [
{
"created_at": "2019-08-24T14:15:22Z",
"id": "string",
"is_active": true,
"key_prefix": "string",
"key_type": "string",
"last_used_at": "2019-08-24T14:15:22Z",
"name": "string",
"revoked_at": "2019-08-24T14:15:22Z"
}
],
"profile": {
"created_at": "2019-08-24T14:15:22Z",
"customer_id": "string",
"display_name": "string",
"email": "string",
"email_verified": true,
"is_admin": true,
"last_login": "2019-08-24T14:15:22Z",
"oauth_providers": [],
"tenant_id": "string"
}
}Create Api Key
Generate a new platform API key. Plaintext returned ONCE. "Say hello to my little friend!" - Tony Montana, Scarface (introducing your new API key)
AuthorizationBearer <token>
In: header
break_glass?Break Glass
Default
falseconfirmation_phrase?Confirmation Phrase
expires_at?Expires At
key_type?Key Type
Default
"live"Match
^(live|test)$name?Name
Default
"Default"Length
length <= 100preset?Preset
rate_limit_per_hour?Rate Limit Per Hour
rate_limit_per_minute?Rate Limit Per Minute
scopes?Scopes
Response Body
curl -X POST "https://loading/v1/settings/api-keys" \ -H "Content-Type: application/json" \ -d '{}'{
"created_at": "2019-08-24T14:15:22Z",
"expires_at": "2019-08-24T14:15:22Z",
"id": "string",
"key_prefix": "string",
"key_type": "string",
"name": "string",
"plaintext_key": "string",
"scopes": [
"string"
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Revoke Api Key
Revoke an API key. Permanent - no undo. "Hasta la vista, baby." - T-800, Terminator 2
AuthorizationBearer <token>
In: header
Path Parameters
key_idKey Id
Format
uuidResponse Body
curl -X DELETE "https://loading/v1/settings/api-keys/497f6eca-6276-4993-bfeb-53cbbbba6f08"Empty
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Change Password
Change password - requires current password verification. "You shall not pass!" - Gandalf (without the right current password)
AuthorizationBearer <token>
In: header
current_passwordCurrent Password
Length
1 <= length <= 128new_passwordNew Password
Length
8 <= length <= 128Response Body
curl -X PUT "https://loading/v1/settings/password" \ -H "Content-Type: application/json" \ -d '{ "current_password": "string", "new_password": "stringst" }'Empty
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Update Profile
Update display name. "They call me MISTER Tibbs!" - Virgil Tibbs, In the Heat of the Night
AuthorizationBearer <token>
In: header
display_name?Display Name
Response Body
curl -X PUT "https://loading/v1/settings/profile" \ -H "Content-Type: application/json" \ -d '{}'{
"created_at": "2019-08-24T14:15:22Z",
"customer_id": "string",
"display_name": "string",
"email": "string",
"email_verified": true,
"is_admin": true,
"last_login": "2019-08-24T14:15:22Z",
"oauth_providers": [],
"tenant_id": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}