Account
Your company's account: who is calling, its keys, its caps, what it spent and the models it may use.
GET/v1/keysList keys.
Only the last four characters are ever shown again.
Answers 2002 fields
dataobject[]The items on this page.
idstringThe key's id.
- Example
key_8f2k
object"api_key"Always api_key.
- Type
"api_key"
mode"live" | "test"live or test: what the key reaches. A test key sees only test users, test deployments and test money.
- Type
"live" | "test"
namestring | nullThe name you gave it; null when it has none.
- Type
string | null
prefixstringThe start of the secret, to tell keys apart: vk_live_ or vk_test_ and a few characters.
- Example
vk_test_8f2k
last4stringThe last four characters of the secret.
- Type
string
scopes("all" | "runtime" | "setup" | "admin")[]What the key may call: all, or any of runtime (conversations, work, routines, connected apps, files, memory, usage), setup (deployments, tests, secrets) and admin (users and keys).
- Type
("all" | "runtime" | "setup" | "admin")[]
status"active" | "expiring" | "expired" | "revoked"active: works, with no end. expiring: works until expires_at (a rolled key in its grace period, or one made to expire). expired or revoked: refused.
- Type
"active" | "expiring" | "expired" | "revoked"
created_atstringWhen it was made, as an ISO 8601 date and time in UTC.
- Type
string
last_used_atstring | nullWhen it last made a call; null when it never has.
- Type
string | null
expires_atstring | nullWhen it stops working; null when it never does.
- Type
string | null
revoked_atstring | nullWhen it was revoked; null while it is not.
- Type
string | null
next_cursorstring | nullSend it as cursor for the next page; null on the last page.
- Type
string | null
const keys = await vestra.keys.list();keys = vestra.keys.list()vestra keysNo sample in your language for this route, so here it is over HTTP.
curl "$VESTRA_BASE_URL/v1/keys" \ -H "Authorization: Bearer $VESTRA_API_KEY"