Fetch API Keys

GET {{endpoint}}/api-keys?projectId={{projectId}}

Returns the API keys of a project, the retrieved API keys can be filtered by passing optional filter properties as a query parameters

Filter Properties:

  • name

  • customAccountId

  • customUserId

  • isActive

To fetch all inactive API keys, provide isActive=false as a query parameter.

Returns

  • 200 if keys were fetched successfully

  • 400 if projectId is invalid or missing from query params

  • 401 if authentication fails

  • 403 if user doesn't have any roles

Request Params

KeyDatatypeRequiredDescription
customAccountIdstring
customUserIdstring
isActivestring
namestring
projectIdstring

HEADERS

KeyDatatypeRequiredDescription
x-api-keystring

RESPONSES

status: OK

[{"key":"live_QYuY39CL6rUfzgpRxT7qLJQY5OMGoMMezQkPonqVhAmey5d444ZqPnOwFnwkcF8o","name":"key with rate limit and expiry","customMetaData":{},"customAccountId":null,"customUserId":null,"env":"live","createdAt":"2022-09-07T10:32:57.262Z","updatedAt":"2022-09-07T10:32:57.262Z","isActive":true,"expiresAt":"2023-12-01T00:00:00.000Z","rateLimitConfigs":{"rateLimit":10,"rateLimitTtl":60}}]