Overview

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

API reference

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:

Examples and tooling

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.

Manage API keys

See Managing API keys for instructions on how to add and delete API keys for your organization.

Was this article helpful?

Have more questions or facing an issue?
Submit a ticket