CentralCSP
APIAPI Keys

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.

GET
/v1/workspaces/{workspaceId}/api-keys

Authorization

headerAuthorizationBearer <JWT>

An OpenID Connect access token from signing in to CentralCSP, acting as the signed-in user.

Path Parameters

workspaceId*string

The workspace's id.

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

A page of API keys.

application/json
  1. response
data*array<>

The API keys on this page.

pagination*

Where this page sits in the full result set.

Example Request
curl -X GET 'https://api.centralcsp.com/v1/workspaces/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/api-keys?limit=50'
Example Response
{  "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  }}