Skip to main content
GET
/
admin
/
api-keys
/
{prefix}
Get API Key
curl --request GET \
  --url https://api.totalis.com/admin/api-keys/{prefix} \
  --header 'x-admin-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "key_prefix": "<string>",
  "entity_type": "<string>",
  "entity_id": "<string>",
  "name": "<string>",
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "last_used_at": "2023-11-07T05:31:56Z",
  "request_count": 123,
  "revoked_at": "2023-11-07T05:31:56Z",
  "revoked_reason": "<string>"
}

Authorizations

​
x-admin-api-key
string
header
required

Admin API key for administrative operations.

Path Parameters

​
prefix
string
required

API key prefix

Response

API key details

​
id
string<uuid>
​
key_prefix
string
​
entity_type
string
​
entity_id
string
​
name
string | null
​
status
enum<string>
Available options:
active,
revoked,
expired
​
created_at
string<date-time>
​
expires_at
string<date-time> | null
​
last_used_at
string<date-time> | null
​
request_count
integer
​
revoked_at
string<date-time> | null
​
revoked_reason
string | null