For REST API requirements for synthetics, see Use the API.
Here are the attributes that can be used when creating and managing monitors with the Synthetics REST API:
Synthetics API attribute
String: The version number.
Integer: The number of monitors returned.
Array of strings: Email addresses for alert notifications with New Relic.
Integer: Number of minutes between checks. Valid values include 1, 5, 15, 30, 60, 360, 720, and 1440.
The UUID for the specific synthetic monitor.
Array of strings: Array of locations by full label.
String: The monitor's name.
String: The BASE64 encoded text for scripted monitors.
Double: Value for the Synthetics SLA report, in seconds.
String: Valid values include
String: Type of monitor. Valid values include:
String: The URI for
Integer: The specific user ID.
Object: options for
When making REST API calls for a specific monitor, include the
monitor_uuid as part of the endpoint. The
monitor_uuid is the GUID which is part of the URL. For example, a selected synthetic monitor has this URL:
monitor_uuid is the value that follows
Additional documentation resources include:
- Manage synthetic monitors via the REST API (API procedures for synthetic simple and scripted monitors)
- Manage synthetic alert notifications via the REST API (REST API calls for email alerts for synthetic monitors)
- Use synthetics label APIs (REST API calls for labels and categories used by synthetic monitors)