Overview
You can use the Synthetics API to:
To use the API, you'll need your API key for all requests and your Synthetics App ID and Monitor ID for some requests.
Getting the API Key¶
Your account's API Key can be found under Settings → API page.
Getting the App ID & Monitor ID¶
- The
<appId>
and<monitorId>
values can be extracted from the URL of the Monitor Overview page. For example, if the Monitor Overview page URL ishttps://apps.sematext.com/ui/synthetics/12345/monitors/276
then theappId
is12345
andmonitorId
is276
. - The
<appId>
can also be obtained by sending a GET request using the above request header and<apiKey>
to the required endpoint:
Region | Endpoint |
---|---|
US | https://apps.sematext.com/users-web/api/v3/apps |
EU | https://apps.eu.sematext.com/users-web/api/v3/apps |
Example:
curl -L -X GET 'https://apps.sematext.com/users-web/api/v3/apps' \
-H 'Authorization: apiKey 9bddb0a6-xxxx-xxxx-xxxx-397d15806cfd'
"success": true,
"message": null,
"data": {
"apps": [
{
"id": 17174,
"name": "Bulk API Test",
"appType": "Synthetics",
"appTypeId": 40000,
<appId>
for the Synthetics App named Bulk API Test
is 17174
.