Synthetics REST API version 1 (deprecated)

アカウントのNewRelicにあるすべてのモニターのリストを表示するには、GETリクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/monitorsに送信します。例えば：

$
curl -v \
>
     -H 'X-Api-Key:API_KEY' https://synthetics.newrelic.com/synthetics/api/v1/monitors

リクエストが成功すると、 200 OKレスポンスが返されます。 返されるデータは、次の形式のJSONオブジェクトになります。

{
  "count": integer,
  "monitors": [
    {
      "id": UUID,
      "name": string,
      "type": string,
      "frequency": integer,
      "uri": string,
      "locations": array of strings,
      "status": string,
      "slaThreshold": double,
      "userId": integer,
      "apiVersion": string
    }
  ]
}

New Relic で単一の既存のモニターを表示するには、GET リクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_IDに送信します。 次の例のMONITOR_ID特定のモニター ID に置き換えます。

$
curl -v \
>
     -H 'X-Api-Key:API_KEY' https://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID

リクエストが成功すると、 200 OKレスポンスが返されます。 返されるデータは、次の形式のJSONオブジェクトになります。

{
  "id": UUID,
  "name": string,
  "type": string,
  "frequency": integer,
  "uri": string,
  "locations": array of strings,
  "status": string,
  "slaThreshold": double,
  "userId": integer,
  "apiVersion": string
}

無効なモニター ID は、エラー404 Not Found : 指定されたモニターは存在しません」を返します。

New Relicのアカウントに新しいモニターを追加するには、モニターを説明するJSONペイロードを含むPOSTリクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/monitorsに送信します。

{
  "name": string [required],
  "type": string (SIMPLE, BROWSER, SCRIPT_API, SCRIPT_BROWSER) [required],
  "frequency": integer (minutes) [required, must be one of 1, 5, 10, 15, 30, 60, 360, 720, or 1440],
  "uri": string [required for SIMPLE and BROWSER type],
  "locations": array of strings (send a GET request to https://synthetics.newrelic.com/synthetics/api/v1/locations to get a list of valid locations) [at least one required],
  "status": string (ENABLED, DISABLED) [required],
  "slaThreshold": double,
}

さらに、REST API 経由でadd a scripted monitorに追加の API エンドポイントを呼び出し、作成したばかりのモニターのスクリプトを送信します。

以下の例の Synthetics REST API attributes をあなたの特定の値に置き換えてください。

$
curl -v \
>
     -X POST -H 'X-Api-Key:API_KEY' \
>
     -H 'Content-Type: application/json' https://synthetics.newrelic.com/synthetics/api/v1/monitors \
>
     -d \
>
'{
$
  "name": "monitor1",
$
  "frequency": 15,
$
  "uri": "http://my-uri.com",
$
  "locations": ["AWS_US_WEST_1"],
$
  "type": "browser"
$
}'

リクエストに成功すると、locationヘッダーで指定された新規作成モニターのURLと共に、201 Createdレスポンスが返されます。可能なエラーコード：

• 400 Bad Request: 1 つ以上のモニター値が無効であるか、リクエストの形式が無効です。 たとえば、周波数が範囲外であるか、指定された 1 つ以上の場所が無効です (応答本文のエラーメッセージを参照してください)。
• 402 Payment Required：モニターを作成すると、アカウントで購入したチェックの限度額を超える定期的なチェックが増加します。

New Relicで既存のモニターを更新するには、PUTリクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_IDに送信します。さらに、スクリプト化モニターの場合、BASE64でエンコードされたスクリプトを更新するの手順に従います。

次の例の MONITOR_ID を特定のモニター ID に置き換え、外形監視 REST APIプロパティを特定の値に置き換えます。

$
curl -v \
>
     -X PUT -H 'X-Api-Key:API_KEY' \
>
     -H 'Content-Type: application/json' https://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID \
>
     -d \
>
'{
$
  "name": "updated monitor name",
$
  "type": "simple",
$
  "frequency": 15,
$
  "uri": "http://my-uri.com/",
$
  "locations": ["AWS_US_WEST_1"],
$
  "status": "enabled",
$
  "slaThreshold": "7.0"
$
}'

PUTリクエストの目的は、ターゲットエンティティを置き換えることにあります。既存のモニターを更新する場合、新しいモニターを作成するときにJSONペイロードで使用する、すべての属性が必要になります。

リクエストに成功すると、空白の本文と共に、204 No Contentレスポンスが返されます。可能なエラーコード：

• 400 Bad Request: 1 つ以上のモニター値が無効であるか、リクエストの形式が無効です。 たとえば、周波数が範囲外であるか、指定された 1 つ以上の場所が無効です (応答本文のエラーメッセージを参照してください)。
• 404 Not Found：指定されたモニターが存在しません。

New Relic 内の既存のモニターを削除するには、 https://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_IDに DELETE リクエストを送信します。 次の例のMONITOR_ID特定のモニター ID に置き換えます。

$
curl -v \
>
     -H 'X-Api-Key:API_KEY' \
>
     -X DELETE https://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID

リクエストが成功すると、空の本文を持つ204 No Contentレスポンスが返されます。 リクエストが失敗すると、レスポンス404 Not Foundが返されます: 指定されたモニターは存在しません。

New Relic で有効なロケーションのリストを取得するには、次のコマンドを使用します。

$
curl -v \
>
     -X GET -H 'X-Api-Key:API_KEY' https://synthetics.newrelic.com/synthetics/api/v1/locations

アカウントの New Relic で特定のSCRIPT_BROWSERまたはSCRIPT_APIモニターに関連付けられたスクリプトを表示するには、GET リクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID/scriptに送信します。 MONITOR_ID特定のモニター ID に置き換えます。 例えば：

$
curl -v
$
     -H 'X-Api-Key: API_KEY'
$
     https://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID/script

リクエストが成功すると、 200 OKレスポンスが返されます。返されるデータは、次の形式のJSONオブジェクトになります。

{
  "scriptText": BASE64 encoded string
}

可能なエラーコード：

• 403 Forbidden: 指定されたモニターのタイプはSCRIPT_BROWSERまたはSCRIPT_APIではありません。
• 404 Not Found: 指定されたモニターが存在しないか、またはモニターに関連付けられたスクリプトが存在しません。

REST APIを使ってNew Relicに新しいスクリプトモニターを追加するには。

1. 標準のAPI手順に従って新しいモニターを追加し、 typeをSCRIPT_BROWSERまたはSCRIPT_APIとして識別します。

2. $MONITOR_UUID/scriptエンドポイントに対するスクリプトのBASE64エンコードバージョンで新規モニターを更新します。

   詳細については、例を参照してください。

アカウントの New Relic の特定のSCRIPT_BROWSERまたはSCRIPT_APIモニターに関連付けられたスクリプトを更新するには、 scriptText (必須) を含む JSON ペイロードを使用して PUT リクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID/scriptに送信します。 scriptLocationsデータは、 Verified Script Executionがオンになっているプライベートロケーションにのみ必要です。

HMAC文字列の生成に使用するパスワードは、プライベートロケーションに設定されたパスワードと一致する必要があります。HMAC文字列の生成には、SHA256アルゴリズムを使用します。

{
  "scriptText": BASE64 encoded String,
  "scriptLocations": [
    {
      "name": Location name,
      "hmac" BASE64 encoded String of SHA256 HMAC for location
    }
  ]
}

MONITOR_ID特定のモニター ID に置き換えます。 スクリプトの例を次に示します。

var assert = require('assert');
assert.equal('1', '1');

この例では、 scriptLocationのパスワードとしてpasswordを使用しています。

$
curl -v \
>
     -H "X-Api-Key:'API_KEY'" \
>
     -H 'content-type: application/json' \
>
    'https://synthetics.newrelic.com/synthetics/api/v1/monitors/MONITOR_ID/script' \
>
     -d \
>
'{ 
$
  "scriptText": "dmFyIGFzc2VydCA9IHJlcXVpcmUoJ2Fzc2VydCcpOw0KYXNzZXJ0LmVxdWFsKCcxJywgJzEnKTs=",
$
  "scriptLocations": [{
$
    "name": "my_vse_enabled_location", 
$
    "hmac": "MjhiNGE4MjVlMDE1N2M4NDQ4MjNjNDFkZDEyYTRjMmUzZDE3NGJlNjU0MWFmOTJlMzNiODExOGU2ZjhkZTY4"
$
  }]
$
}'

リクエストに成功すると、空白の本文と一緒に204 No Contentのレスポンスが返されます。可能なエラーコード：

• 400 Bad Request: scriptTextまたはhmacに対する無効のBASE64でエンコードされた文字列です。
• 403 Forbidden: 指定されたモニターのタイプがSCRIPT_BROWSERまたはSCRIPT_APIではありません。
• 404 Not Found: 指定されたモニターが存在しません。

以下の例では、スクリプトによるブラウザモニタを作成するためのcurlコマンドを示しています。

• スクリプトの上部で、特定の値で変数を交換します。

• scriptfile変数については、作成するスクリプトのファイル名を特定します。以下に示すのは、この例で使用するためにsample_synth_script.jsとして保存できるサンプルスクリプトです：

  var assert = require("assert");
  $browser
    .get("http://example.com")
    .then(function () {
      // Check the H1 title matches "Example Domain"
      return $browser.findElement($driver.By.css("h1")).then(function (element) {
        return element.getText().then(function (text) {
          assert.equal("Example Domain", text, "Page H1 title did not match");
        });
      });
    })
    .then(function () {
      // Check that the external link matches "http://www.iana.org/domains/example"
      return $browser
        .findElement($driver.By.css("div > p > a"))
        .then(function (element) {
          return element.getAttribute("href").then(function (link) {
            assert.equal(
              "http://www.iana.org/domains/example",
              link,
              "More information link did not match"
            );
          });
        });
    });

  コピー

この例は、 SCRIPTED_BROWSERモニターを作成するbashスクリプトを示しています。

$
#!/bin/bash
$

$
# Admin API key from your account settings
$
adminAPIKey=''
$
# Other attributes found at https://docs.newrelic.com/docs/apis/synthetics-rest-api/monitor-examples/attributes-synthetics-rest-api#api-attributes
$
monitorName='Test API Script'
$
monitorType='SCRIPT_BROWSER'
$
frequency=1440
$
locations='"AWS_US_WEST_1", "AWS_US_EAST_1"'
$
slaThreshold=7.0
$
# Location of the file with your script
$
scriptfile=sample_synth_script.js
$

$
# Test that the script file exists (does not validate content)
$
if [ -e "$scriptfile" ]
$
then
$
  script=$(cat "$scriptfile")
$

$
  payload="{  \"name\" : \"$monitorName\", \"frequency\" : $frequency,    \"locations\" : [ $locations ],   \"status\" : \"ENABLED\",  \"type\" : \"$monitorType\", \"slaThreshold\" : $slaThreshold, \"uri\":\"\"}"
$
  echo "Creating monitor"
$

$
  # Make cURL call to API and parse response headers to get monitor UUID
$
  shopt -s extglob # Required to trim whitespace; see below
$
  while IFS=':' read key value; do
$
    # trim whitespace in "value"
$
    value=${value##+([[:space:]])}; value=${value%%+([[:space:]])}
$
    case "$key" in
$
        location) LOCATION="$value"
$
                ;;
$
        HTTP*) read PROTO STATUS MSG <<< "$key{$value:+:$value}"
$
                ;;
$
    esac
$
  done < <(curl -sS -i  -X POST -H "X-Api-Key:$adminAPIKey" -H 'Content-Type: application/json' https://synthetics.newrelic.com/synthetics/api/v1/monitors -d "$payload")
$

$
  # Validate monitor creation & add script unless it failed
$
  if [ $STATUS = 201 ]; then
$
    echo "Monitor created, $LOCATION "
$
    echo "Uploading script"
$
      # base64 encode script
$
      encoded=`echo "$script" | base64`
$
      scriptPayload='{"scriptText":"'$encoded'"}'
$
        curl -s -X PUT -H "X-Api-Key:$adminAPIKey" -H 'Content-Type: application/json' "$LOCATION/script" -d $scriptPayload
$
        echo "Script uploaded"
$
  else
$
    echo "Monitor creation failed"
$
  fi
$

$
else
$
  echo "script file not found, not creating monitor"
$
fi