Sign in

List Workspace Keys

Changed on

List workspace key/secret pairs for this workspace. Backend SDKs authenticate with a workspace key and secret (Suprsend(workspace_key, workspace_secret)).

Every response - including this list - returns the full key and secret in plain text. Handle the response as sensitive data.

get/v1/{workspace}/ws_key/

Request

  • Base URL: https://management-api.suprsend.com
  • URL: https://management-api.suprsend.com/v1/{workspace}/ws_key/
  • Auth: API key in header ServiceToken <token>

Path parameters

workspacestring required

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

Response

Successfully retrieved workspace keys. Each result includes the full key and secret in plain text.

Example response

{
  "results": [
    {
      "id": "ws_key_01ABCDEFGHJKMNPQRSTVWXYZ0",
      "name": "ops-cli",
      "key": "SS.WSK.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "secret": "SS.WSS.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
      "created_by": {
        "name": "System User",
        "email": "user@example.com"
      },
      "rotated_by": {
        "name": "System User",
        "email": "user@example.com"
      },
      "deleted_by": {
        "name": "System User",
        "email": "user@example.com"
      }
    }
  ]
}

Changes