• /
  • Log in
  • Free account
Docs

Payload attributes for the Synthetics REST API

For REST API requirements for synthetics, see Use the API.

Synthetic monitoring attributes

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

Synthetics API attribute

Definition

apiVersion

String: The version number.

count

Integer: The number of monitors returned.

emails

Array of strings: Email addresses for alert notifications with New Relic.

frequency

Integer: Number of minutes between checks. 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 by full label.

name

String: The monitor's name.

scriptLocations

String: The name and hmac values for private locations using Verified Script Execution.

scriptText

String: The BASE64 encoded text for scripted monitors.

slaThreshold

Double: Value for the Synthetics SLA report, in seconds.

status

String: Valid values include ENABLED, MUTED, and DISABLED.

type

String: Type of monitor. Valid values include:

  • SIMPLE (Ping)
  • BROWSER
  • SCRIPT_BROWSER
  • SCRIPT_API

uri

String: The URI for SIMPLE and BROWSER monitor types; 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

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:

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

The monitor_uuid is the value that follows /monitors/.

For more help

Additional documentation resources include:

Docs
Create issueEdit page
Copyright © 2021 New Relic Inc.