Skip to main content
For programmatic access to the public API, use a team API key sent as a Bearer token. Browser sessions authenticated through the Wirespeed UI also work on /v1 endpoints, but integrations and automation should use a team API key.

​
Create an API key

  1. Sign in as a team Admin (only Admins can access Team API Keys).
  2. In Wirespeed, open Settings → Team.
  3. Scroll to Team API Keys.
  4. Create a key with a name, role, and expiration (1–720 days).
  5. Copy the token immediately — it is shown only once. Keys are prefixed with wspd-.
See Team Settings for full details on team API keys and permissions.
If you lose a team API key, delete it and create a new one. Existing keys cannot be viewed again after creation.

​
Send the key with requests

Include the full key (including the wspd- prefix) in the Authorization header:
In the API playground on each endpoint page, paste the same value into the Authorization field (Bearer token).
Do not paste production API keys into shared or untrusted API playgrounds. Prefer curl or your own test environment when handling real credentials.

​
Check which identity and role a key has

Call GET /v1/auth/me to see the identity behind a key and the role it grants:
The role field is the permission level the key itself carries, and teamId is the team it acts on.
A team API key authenticates as a service account user, so the user endpoints describe that service account rather than the key’s own permissions. Use /v1/auth/me to confirm a key’s role.