Get API key details

GET /api/v1/api-keys/{keyId} Select code sample Fetch cURL

const url = 'https://localhost:8080/api/v1/api-keys/example';const options = {method: 'GET', headers: {Authorization: '
  
   '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}

curl --request GET \  --url https://localhost:8080/api/v1/api-keys/example \  --header 'Authorization: 
  
   '

Get details of one of the authenticated user’s API keys

Authorizations

Section titled “Authorizations ”

BearerAuth
ApiKeyAuth

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ” keyId required string

API Key ID

Responses

Section titled “ Responses ”

200

Section titled “200 ”

API key details

Media type application/json object allowedIps Array createdAt string createdBy

Key lifecycle

string description string expiresAt string id string keyId string lastUsedAt string name string organizationId integer projectId integer revocationReason string revokedAt string revokedBy string scopes

Permissions and scope

Array status

Status

string usageCount integer userId

User context

string

Example generated

{  "allowedIps": [    "example"  ],  "createdAt": "example",  "createdBy": "example",  "description": "example",  "expiresAt": "example",  "id": "example",  "keyId": "example",  "lastUsedAt": "example",  "name": "example",  "organizationId": 1,  "projectId": 1,  "revocationReason": "example",  "revokedAt": "example",  "revokedBy": "example",  "scopes": [    "example"  ],  "status": "example",  "usageCount": 1,  "userId": "example"}