API keys
Create service keys that let other systems call the Nuvelics API for your organization, and revoke them.
The API keys tab lists the service keys that let other systems call the Nuvelics API for your organization. A service key acts for the organization rather than as a person. This page is the steps; what keys are and how they relate to your account is in API keys.
Who can use it
Owners and admins (apikey:manage). The tab is missing for Members and Viewers.
Read the list
Each key shows its Name, Type (Service), Owner (Service for a service key), the Key prefix, when it was Updated, when it was Last used, and its Status: Active or Revoked. Revoked keys are hidden until you turn on Show revoked. Search with Search by name, or choose + Add filter to filter by Type, Owner, Created or Updated. A long list loads more with Load more.
Create a key
- Choose Create key.
- On Create service key, enter a Name that says what the key is for, such as
ci-pipeline. - In Permissions, use Add a permission… to pick what the key may do. The options are the permissions you hold yourself, in plain words such as View stories or Push stories to NRCS.
- Choose Create key.
You see API key created and a dialog, Your new API key, showing the key once: "Copy this key now — it won't be shown again." Choose Copy to clipboard and store it somewhere safe, such as your secrets manager, then choose Done. Nuvelics cannot show it again; if you lose it, create a new key and revoke the old one.
If something is missing you are told Name is required or Select at least one permission. You cannot grant more than you hold: "You can only grant permissions you hold". Give a key only the permissions its job needs.
The key is the credential other systems present when they call the API.
Revoke a key
- Open the API key actions menu on the key and choose Revoke.
- Read Revoke API key, which says anything using the key immediately loses access, and choose Revoke.
You see API key revoked and the key leaves the list; with Show revoked on, it stays and shows as Revoked.
Other ways to manage keys
- CLI, to list keys only:
nuvelics api-key. - API: API keys.