Managing API keys

See Overview for what the SquaredUp API can do.

API keys are managed on the API settings page.

You might need to create an API key to use with the Usage plugin or the SquaredUp Cloud provider for SquaredUp DS.

An API key belongs to your organization, not to the user who created it. Anyone with the key has the same programmatic access to your organization’s data as the SquaredUp API itself, so treat it like a password and never share it outside your organization. Adding and deleting API keys needs administrator rights.

Add an API key

Each key is only ever shown once, at the point you create it. If you lose it, delete it and create a new one.

1. Navigate to Settings > Organization > API.
2. Click Add API key.
3. Complete the following in the Add API key window.

See API settings for a full breakdown of these fields.

1. Name:
   Enter a name for the API key, from 5 to 128 characters.
2. Description:
   Optionally, enter a description for the API key, from 5 to 128 characters.
3. API Key:
   Click Generate API key.

1. Copy the API key and store it somewhere safe. You won’t be able to view it again once you close this window.

Delete an API key

Deleting an API key is immediate and permanent. Any integration, plugin or script still using it, such as the Usage plugin data source or a Terraform provider, starts failing to authenticate straight away. Create a replacement key first if you need to keep that access working.

1. Navigate to Settings > Organization > API.
2. Click Delete API key next to the key you want to remove.
3. Click Delete to confirm. Anything using the key stops working immediately.

Was this article helpful?