List API keys

Lists the workspace's API keys with who created each one, when it expires, and when it was last used. The secret itself is never returned. API keys cannot call this endpoint, so use a user token.

Requires the admin role on the workspace and the api_keys plan feature.

Authorization

AuthorizationBearer <token>

An OpenID Connect access token issued by Keycloak, acting as the signed-in user.

In: header

Path Parameters

workspaceId*string

Query Parameters

cursor?string

The nextCursor of the previous page. Omit it to start from the beginning. A cursor encodes a position and is not meant to be built by hand.

limit*|

How many items to return, from 1 to 200.

Range1 <= value <= 200

Default50

q?string

Match part of the key name.

Lengthlength <= 255

Response Body

`application/json`

curl -X GET "https://example.com/v1/workspaces/string/api-keys?limit=50"

{  "data": [    {      "id": "string",      "workspaceId": "string",      "name": "CI pipeline",      "prefix": "ccsp_a1",      "createdBy": "string",      "createdByUser": {        "id": "string",        "email": "string",        "firstName": "string",        "lastName": "string",        "picture": "string"      },      "allowedIps": [        "string"      ],      "expiresAt": "2019-08-24T14:15:22Z",      "lastUsedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "nextCursor": "string",    "hasMore": true,    "total": 0  }}