• /
  • Log in
  • Free account
Docs

Synthetics REST API version 1 (deprecated)

Deprecated

Currently New Relic supports two versions of the Synthetics API: v1 and v3. Version 3 was released October 2016. Version 1 is deprecated and will eventually no longer be available. No termination date has been announced. However, no further development or modifications will be made to v1.

Caution

Recommendation: Create new monitors using the v3 Synthetics API and migrate v1 scripts to their v3 equivalent.

To use the REST API for New Relic's synthetic monitoring, you must activate API access and generate your Admin User's API key from your account settings. Then you can make standard API calls via the command line.

Managing simple and scripted monitors

You must use your Admin User's API key to make Synthetics REST API calls. The account's REST API key will not work.

Caution

The Synthetics REST API limits an account's rate of requests to three requests per second. Requests made in excess of this threshold will return a 429 response code.

These examples show curl commands:

Managing scripted monitors

In addition to the general API, there are several API methods for the monitor types Scripted Browser (SCRIPT_BROWSER) and API Test (SCRIPT_API).

These examples show curl commands.

Scripted browser example

Here is an example of using New Relic's REST API and the bash script to create a scripted browser monitor.

Synthetics attributes

Here are the attributes used with Synthetics REST API calls, listed in alphabetical order.

Synthetics API attribute

Definition

apiVersion

String: The version number.

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 Synthetics 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.

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 Synthetics 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.