API keys

API keys authenticate machine-to-machine requests to the NetBox Cloud API. Use them to integrate NetBox Cloud operations into external scripts, pipelines, or automation tooling without user credentials.

You manage keys in the Console at https://app.netboxlabs.com/settings/api-keys.

Keys use the format nblc_<id>.<token>.

Create a key

1. Go to Settings > API Keys in the Console.
2. Click Create API key.
3. Enter a name to identify the key (for example, "Backup automation").
4. Set an expiry date, or leave it blank for no expiry.
5. Select the permissions the key needs. See Permissions for details.
6. Click Create.

Copy your key now

The key value is displayed only once when created. Copy it before closing the dialog -- it cannot be retrieved afterward. It will need to be deleted and recreated.

List keys

All keys for your organization are listed at Settings > API Keys. The key value is not shown in the list. Use the name and created date to identify keys.

Delete a key

From Settings > API Keys, click Delete next to the key you want to remove.

Deleting a key revokes it immediately. Any request using a deleted key returns 401 Unauthorized.