---
title: Payload attributes for the synthetic monitoring REST API
source: https://docs.newrelic.com/docs/apis/synthetics-rest-api/monitor-examples/payload-attributes-synthetics-rest-api
---

For REST API requirements for synthetics, see [Use the API](https://docs.newrelic.com/docs/apis/synthetics-rest-api/monitor-examples/manage-synthetics-monitors-rest-api#use-api).

## Synthetic monitoring attributes [#api-attributes]

Here are the attributes that can be used when creating and managing monitors with the synthetic monitoring REST API:

| **Synthetic monitoring API attribute** | **Definition**                                                                                                                                                                                                                                                                                                                                     |
| -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `apiVersion`                           | String: The version number.                                                                                                                                                                                                                                                                                                                        |
| `count`                                | Integer: The number of monitors returned.                                                                                                                                                                                                                                                                                                          |
| `emails`                               | Array of strings: Email addresses for [alert notifications](https://docs.newrelic.com/docs/apis/synthetics-rest-api/alert-examples/manage-synthetics-alert-notifications-rest-api) with New Relic.                                                                                                                                                 |
| `frequency`                            | Integer: Number of minutes between [checks](https://docs.newrelic.com/docs/synthetics/new-relic-synthetics/using-monitors/add-edit-monitors#setting-frequency). Valid values include 1, 5, 15, 30, 60, 360, 720, and 1440.                                                                                                                         |
| `id`                                   | The UUID for the specific synthetic monitor.                                                                                                                                                                                                                                                                                                       |
| `locations`                            | Array of strings: [Array of locations](https://docs.newrelic.com/docs/synthetics/new-relic-synthetics/using-monitors/add-edit-monitors#setting-location) by full label.                                                                                                                                                                            |
| `name`                                 | String: The [monitor's name](https://docs.newrelic.com/docs/synthetics/new-relic-synthetics/using-monitors/add-edit-monitors#setting-name).                                                                                                                                                                                                        |
| `scriptLocations`                      | String: The `name` and `hmac` values for [private locations](https://docs.newrelic.com/docs/apis/synthetics-rest-api/monitor-examples/manage-synthetics-monitor-scripts-rest-api) using [Verified Script Execution](https://docs.newrelic.com/docs/synthetics/new-relic-synthetics/private-locations/verified-script-execution-private-locations). |
| `scriptText`                           | String: The BASE64 encoded text for [scripted monitors](https://docs.newrelic.com/docs/apis/synthetics-rest-api/monitor-examples/manage-synthetics-monitor-scripts-rest-api).                                                                                                                                                                      |
| `slaThreshold`                         | Double: Value for the [synthetic monitoring SLA report](https://docs.newrelic.com/docs/synthetics/new-relic-synthetics/pages/synthetics-sla-report-aggregate-monitor-metrics), in seconds.                                                                                                                                                         |
| `status`                               | String: Valid values include `ENABLED` and `DISABLED`.                                                                                                                                                                                                                                                                                             |
| `type`                                 | String: [Type of monitor](https://docs.newrelic.com/docs/synthetics/new-relic-synthetics/using-monitors/add-edit-monitors#settings-type). Valid values include: - `SIMPLE` (Ping) - `BROWSER` - `SCRIPT_BROWSER` - `SCRIPT_API`                                                                                                                    |
| `uri`                                  | String: The URI for `SIMPLE` and `BROWSER` [monitor types](https://docs.newrelic.com/docs/synthetics/new-relic-synthetics/using-monitors/add-edit-monitors#settings-type); for example, `http://my-site.com`. Optional for `SCRIPT_BROWSER` and `SCRIPT_API`.                                                                                      |
| `userID`                               | Integer: The specific user ID.                                                                                                                                                                                                                                                                                                                     |
| `options`                              | Object: options for `SIMPLE` and `BROWSER` monitor types. Options include: - `validationString`: string - `verifySSL`: boolean (true, false) - `bypassHEADRequest`: boolean (true, false) - `treatRedirectAsFailure`: boolean (true, false)                                                                                                        |

## Specific monitor endpoint [#specific-monitor]

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](https://docs.newrelic.com/docs/synthetics/new-relic-synthetics/pages/synthetics-overview-page-view-monitors-performance) has this URL:

```
https://synthetics.newrelic.com/accounts/nnnn/monitors/ab123-c456d-e78-90123-f45g
```

The `monitor_uuid` is the value that follows `/monitors/`.