Synthetics REST API を使用すると、 セキュアな認証情報 データを変更または取得するための API コールを行うことができます。このドキュメントでは、API の要件を説明し、API の curl コマンドの例を示します。
セキュアな認証情報の設定およびUIでの設定に関する一般的なガイドラインについては、 セキュアな認証情報 を参照してください。
要求事項とルール
この機能に関する一般的なルールについては、 secure credentials requirements を参照してください。
APIの要件やルールには
- 一般的な Synthetics REST API の要件 を参照してください。
- アカウントのリクエスト数は、1秒間に3回に制限されています。この制限を超えたリクエストには、429のレスポンスコードが返されます。
- キーの値は、APIを介してアクセスすることはできません。権限のないユーザーは、安全なキーの値にアクセスすることはできません。
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" }'
リクエストが成功すると、 201 Created
レスポンスが返され、新しく作成されたセキュア・クレデンシャルの URI が location
ヘッダーに指定される。考えられるエラーコードは以下の通りである。
303 See Other
: 指定されたキーは既に存在しています。返される location header には、その key への URI が含まれる。400 Bad Request
: Key too long or missing, value too long or missing, non-parsable JSON payload.
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}
1つのセキュアなクレデンシャルを表示するには、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 を返します。指定されたキーは存在しません
.
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 を返します。指定されたキーは存在しません
.
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
なお、指定したキーが存在しない場合はエラーになりません。