シンセティック・モニタリング・セキュア・クレデンシャル・APIの使用

安全な認証情報を New Relic アカウントに送信するには、安全な認証情報を記述した JSON ペイロードを含むPOSTリクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/secure-credentialsに送信します。 次に例を示します。

{
  "key": string [required, 1-64 characters uppercase],
  "value": string [required, 1-3,000 characters],
  "description": string [optional]
}

ここでは、curlコマンドを使った例を紹介します。

$
curl -v \
>
     -X POST -H "Api-Key:$API_KEY" \
>
     -H 'Content-Type: application/json' \ 
>
     'https://synthetics.newrelic.com/synthetics/api/v1/secure-credentials' \
>
     -d '{ "key": "MYKEY", "value": "my value", "description": "Description of MYKEY" }'

リクエストが成功すると、 locationヘッダーで指定された新しく作成された安全なクレデンシャルのURIを使用して201 Created応答が返されます。考えられるエラーコードは次のとおりです。

• 303 See Other：指定されたキーはすでに存在します。返されるロケーションヘッダーには、キーへのURIが含まれます。
• 400 Bad Request：キーが長すぎるか欠落している、値が長すぎるか欠落している、解析できないJSONペイロード。

New Relic アカウント内のすべての安全な認証情報のリストを表示するには、 GETリクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/secure-credentialsに送信します。 例えば：

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

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

{
  "secureCredentials": [
    {
      "key": "MYKEY1",
      "description": "Description of MYKEY1",
      "createdAt": "2016-09-26T23:12:46.981+0000",
      "lastUpdated": "2016-09-26T23:12:46.981+0000"
    },
    {
      "key": "MYKEY2",
      "description": "Description of MYKEY2",
      "createdAt": "2016-09-26T23:12:46.981+0000",
      "lastUpdated": "2016-09-26T23:12:46.981+0000"
    }
  ],
  "count": 2
}

単一の安全な認証情報を表示するには、 GETリクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/secure-credentials/$KEYに送信します。

curl -v \
     -H "Api-Key:$API_KEY" \
     'https://synthetics.newrelic.com/synthetics/api/v1/secure-credentials/$KEY'

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

{
  "key": string,
  "description": string,
  "createdAt": date,​
  "lastUpdated": date
}

無効なキーは404 Not Found: The specified key doesn't existを返します。

New Relic の既存の資格情報を更新するには、 PUTリクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/secure-credentials/$KEYに送信します。

$
curl -v \
>
     -X PUT -H "Api-Key:$API_KEY" \
>
     -H 'Content-Type: 'application/json' \
>
     https://synthetics.newrelic.com/synthetics/api/v1/secure-credentials/$KEY' \
>
     -d  '{ "key": "MYKEY", "value": "my value", "description": "Description of MYKEY" }'

無効なキーは404 Not Found: The specified key doesn't existを返します。

New Relic 内の既存の資格情報を削除するには、 DELETEリクエストをhttps://synthetics.newrelic.com/synthetics/api/v1/secure-credentials/$KEYに送信します。

$
curl -v \
>
     -H "Api-Key:$API_KEY" \
>
     -X DELETE \
>
     https://synthetics.newrelic.com/synthetics/api/v1/secure-credentials/$KEY

なお、指定したキーが存在しない場合はエラーになりません。