Documentation Grafana Cloud Testing and synthetics Synthetic Monitoring Cloud REST API

Grafana Cloud Synthetic Monitoring REST API

The Grafana Cloud Synthetic Monitoring REST API provides programmatic access to Synthetic Monitoring resources.

Authentication and authorization

To authenticate with the Grafana Cloud Synthetic Monitoring API, you need the following:

• A Synthetic Monitoring access token
• Your Synthetic Monitoring backend address

Get a Synthetic Monitoring access token

To generate an access token:

1. Log in to your Grafana Cloud account.
2. Go to Testing & synthetics > Synthetics > Config.
3. Click the Access tokens tab.
4. Click Generate access token.
5. Copy and save your access token.

Get your Synthetic Monitoring backend address

To find your backend address:

1. Log in to your Grafana Cloud account.
2. Go to Testing & synthetics > Synthetics > Config.
3. On the General tab, copy the URL address under “Your backend address is”. For example: synthetic-monitoring-api-us-east-0.grafana.net.

Example request

Include the access token in the Authorization header and replace the backend address for all requests to the API. The following example lists all checks:

HTTP Copy

GET https://@@@SM_BACKEND_ADDRESS@@@/api/v1/check
Authorization: Bearer @@@SM_ACCESS_TOKEN@@@

API reference

View the complete Synthetic Monitoring API reference.

Download the OpenAPI specification file.