api-keys

Create an API key

Create an API key for programmatic access. The secret is returned once, in this response, and is never retrievable again.

Requires an interactive session — an API key cannot create further keys.

Choose the narrowest scopes that work: scans:read alone cannot create or delete scans, which makes it the safer credential for anything unattended.

post/api/v1/keys

Request

  • Base URL: https://api.sytecheck.app (the document declares no server; this is the origin it was published from)
  • URL: https://api.sytecheck.app/api/v1/keys
  • Auth: HTTP bearer

Request body

labelstring required

Human-readable name to identify this key (e.g. 'CI pipeline').

scopesstring[]

What this key may do: scans:read, scans:write. Defaults to all of them. A read-only key cannot spend scan quota, which is the safer choice for anything that runs unattended. Scopes never widen what a key can reach: account, billing, and key-management routes are closed to every key.

Example request

{
  "label": "Production integration",
  "scopes": [
    "scans:read",
    "scans:write"
  ]
}

Response

Successful Response

idinteger required
labelstring required
key_prefixstring required
scopesstring[]

What this key may do.

is_activeboolean required
request_countinteger required
scan_countinteger required
created_atstring date-time required
last_used_atstring date-time nullable required
revoked_atstring date-time nullable required
api_keystring required

The secret key. Store it now; it is never shown again.

Changes

No recorded changes to this operation across all 1 revision of this API.