Skip to content
Certyn

API Keys API

Create and revoke API keys for CLI, CI, extension, and other automation flows.

API keys are intended for CI, automation, browser extension flows, and other non-interactive clients.

Creation returns the full token only once

When you create an API key, the response includes the full apiKey token a single time. Store it immediately in your secret manager, CI variable store, or extension setup flow.

Create API key

POST/api/settings/api-keysBearer Token

Body:

{
  "name": "CI smoke gate",
  "scopes": ["ci:trigger", "ci:status", "ci:cancel"]
}

If scopes is omitted, Certyn applies the default automation-oriented scope set.

Common scopes include:

  • ci:trigger, ci:status, ci:cancel
  • process:execute, quicktest:execute
  • testcase:read, testcase:write, testcase:execute
  • ticket:read, ticket:write, ticket:retest
  • execution:read
  • chat:use
  • runner:manage
  • platform:manage

For recommended scope bundles, see CLI Auth and Config.

Delete API key

DELETE/api/settings/api-keys/{id}Bearer Token

Auth header format

For direct HTTP calls, send API keys with:

curl -H "X-API-Key: cyn_live_<...>" https://api.certyn.io/api/projects

Notes

  • API key management endpoints are JWT-only.
  • The create/delete REST surface is public and documented here.
  • The full token is never returned again after creation.
PreviousWebhooks APINextCI Runs API