Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

List API keys

GET /api/v1/api-keys Select code sample Fetch cURL 
const url = 'https://localhost:8080/api/v1/api-keys';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 \  --header 'Authorization: 
  
   '

List API keys owned by the authenticated user, optionally filtered by organization

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ” organization_id string

Filter by organization ID

Responses

Section titled “ Responses ”

200

Section titled “200 ”

List of API keys

Media type application/json object apiKeys Array 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 total integer
Example generated
{  "apiKeys": [    {      "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"    }  ],  "total": 1}

400

Section titled “400 ”

Bad request - Invalid organization ID

Media type application/json object error string error_description string
Example 
{  "error": "Unauthorized",  "error_description": "Invalid token"}

401

Section titled “401 ”

Unauthorized - Authentication required

Media type application/json object error string error_description string
Example 
{  "error": "Unauthorized",  "error_description": "Invalid token"}

500

Section titled “500 ”

Internal server error

Media type application/json object error string error_description string
Example 
{  "error": "Unauthorized",  "error_description": "Invalid token"}
Previous
Overview Next
Create API key