SUsuprsend

List Workspace API Keys

Changed on

List API keys scoped to a workspace. Secret values are never returned on list; only a masked preview is shown.

get/v1/{workspace}/ws_api_key/

Request

Path parameters

workspacestring required

Workspace slug (e.g. staging, production).

Response

Successfully retrieved API keys.

Example response

{
  "results": [
    {
      "id": "ws_apik_exampleId01",
      "masked_api_key": "SS.XXXXXXX*****",
      "name": "backend-prod",
      "created_by": {
        "name": "System User",
        "email": "user@example.com"
      },
      "deleted_by": {
        "name": "System User",
        "email": "user@example.com"
      }
    }
  ]
}

Changes

  • 5f0169085547Revision changes
    • breaking

      response property detail list-of-types was widened by adding types array and object to media type application/json of response 401

    • breaking

      response property detail list-of-types was widened by adding types array and object to media type application/json of response 404