Get an API key
Returns the API key with the given ID, including its metadata and access. Restricted members can read only keys stored in their namespace.
GET
Returns the API key with the given ID, including its metadata and access. Restricted members can read only keys stored in their namespace.
apiKeyheader
x-api-key<token>id*stringMatch
^key_[0-9a-hjkmnp-tv-z]{16,24}$ApiKey
application/json- response
id*stringname*stringkey?string|nullstart*string|nullend*string|nulldescription?string|nullcreatedAt*stringexpiresAt*string|nulllastUsedAt*string|nullisActive*booleanaccess*|owner*|nullimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.apiKeys.get({
"id": "example"
});Example Response
{
"id": "string",
"name": "string",
"key": "string",
"start": "string",
"end": "string",
"description": "string",
"createdAt": "string",
"expiresAt": "string",
"lastUsedAt": "string",
"isActive": true,
"access": {
"mode": "full"
},
"owner": {
"id": "string",
"name": "string",
"email": "string"
}
}