API
This feature is available with an Enterprise plan
SquaredUp offers an API that can be used to:
- Automate the configuration of entities (e.g. data sources, workspaces, dashboards, etc.)
- Trigger specific actions (e.g. send a dashboard screenshot to Slack)
- Perform many of the actions natively available to the SquaredUp Cloud web application
For detailed information on using the SquaredUp API (such as authentication, access control and request / response examples) see one of the following, depending on your region:
The API covers many scenarios. The easiest way to get started is to browse the SquaredUp API Examples GitHub repository, which includes a number of common examples for interacting with the API- GitHub - squaredup/SquaredUpAPI: Example usage of SquaredUp API.
If you are using Terraform, we have also made available a Terraform provider here- Terraform Registry.
Creating and API key
You might need to create an API key to use with the Usage plugin or the SquaredUp Cloud provider for SquaredUp DS.
In SquaredUp, browse to Settings > Advanced > API > Add API Key. Give the API key a name and description and click Generate API key. Copy the API key to your clipboard or somewhere safe as you won't be able to view it again in here.