Create and manage API keys

Create, store, use, and revoke workspace API keys for the Protodesk Platform API.

Updated

API keys authenticate requests to the Protodesk Platform API for one workspace. Treat each key as a secret with workspace-level access.

Create a key

  1. Open Settings → API.
  2. Select Create key.
  3. Enter a name that identifies the integration, such as Order sync production.
  4. Select Create key.
  5. Copy the secret immediately and store it in a secret manager.

Protodesk shows the complete secret only once. The API page later displays only a safe key identifier.

Send the key as a Bearer token to the Platform API:

Authorization: Bearer <key>

The base URL shown in the product is https://api.protodesk.io/v1.

Keep keys safe

  • Create a separate key for each integration and environment.
  • Never put a live key in browser code, screenshots, tickets, or source control.
  • Store keys in server-side environment variables or a secret manager.
  • Replace a key if it may have been exposed.
  • Review the Last used date to find unused credentials.

Revoke a key

Open Settings → API, locate the key, and select Revoke. Requests using that key are rejected immediately, and revocation cannot be undone.

Create and test a replacement before revoking a key that serves a production integration. If the Platform API is unavailable for the workspace, the API page displays that state instead of allowing key creation.

Related articles