Integrations · API keys
Docs / Integrations

API keys

Create an API key under Account → Integrations and call the NevTan Cloud public API from scripts, CI, or Zapier.

An API key lets something other than you at the dashboard — a script, a CI pipeline, a tool like Zapier — call NevTan Cloud as you. Create and revoke keys under Account → Integrations.

Create a key

  1. 1
    Open Account → Integrations
    In the API Keys card, click Create Key.
  2. 2
    Fill in the form
    Give it a name, pick Live or Test, and optionally limit it to one project and set an expiry date.
  3. 3
    Copy it now
    The full key (nvt-live-… or nvt-test-…) is shown once. NevTan stores only a hash of it, so it can never be shown again.
ParameterTypeDescription
namerequiredstringLabel shown in the key list.
environment"live" | "test"Decides the key prefix, nvt-live- or nvt-test-. Defaults to live.
projectstringLimit the key to one project. Calls for any other project are refused with 403.
expiresdateThe key stops working at the end of this day (UTC).

Call the API

Send the key in the X-API-KEY header (or as Authorization: Bearer <key>) to any /api/v1/public/ endpoint. GET /api/v1/public/me tells you which account and project the key acts for:

Check a key
 
Response
 
StatusWhat it means
401The key is missing, wrong, revoked, or expired.
403The key is limited to another project, or lacks the scope for this action.
429More than 120 requests in a minute with this key. Wait for the Retry-After seconds.

Limits

  • Up to 10 active keys per account. Revoke one to create another.
  • Last used in the key list updates at most once a minute.
  • A key can't create, list, or revoke keys — that always needs you signed in to the console.
  • The same key also works with the AI Gateway.
Important
Revoking a key takes effect immediately: the next call with it gets 401. Put a replacement in place first if this is a planned rotation.