API settings

The SquaredUp API lets you automate the configuration of entities (such as data sources, workspaces and dashboards) and trigger specific actions (such as sending a dashboard screenshot to Slack). API keys are created and managed from Settings > Organization > API.

You can view, add and delete your API keys from Settings > Organization > API.

See Overview.

API keys list

Column
Description
Name
The display name given to the API key.
Description
The description given to the API key.
API Key
The last part of the key, shown for identification. The full key is only ever shown once, when it is created.

Page controls

Icon
Control
Description
—
Add API key
Click to open the Add API key window.
Delete API key
Click to permanently delete the API key. Anything using it stops working.

Add API key window

Setting
Description
Name
Required. Enter a name for the API key, from 5 to 128 characters.
Description
Optional. Enter a description for the API key, from 5 to 128 characters.
API Key
Click Generate API key to create the key. Copy it and store it somewhere safe, as it is only ever shown once.

API key permissions

Adding and deleting API keys needs administrator rights. Everyone else cannot see this settings page.

See Managing API keys for how to add and delete API keys.

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket