합성 모니터링 REST API 를 사용하면 API를 호출하여 보안 자격 증명 데이터를 변경하거나 검색할 수 있습니다. 이 문서는 API 요구 사항을 설명하고 API curl 명령 예제를 포함합니다.
보안 자격 증명을 설정하고 UI에서 설정하는 일반적인 지침은 보안 자격 증명 을 참조하십시오.
중요
이제 NerdGraph API 를 사용하여 보안 자격 증명을 관리할 수 있습니다.
요구 사항 및 규칙
이 기능에 대한 일반 규칙은 보안 자격 증명 요구 사항 을 참조하십시오.
API 요구 사항 및 규칙은 다음과 같습니다.
- 일반 종합 모니터링 REST API 요구사항 을 참조하십시오.
- 계정의 요청 속도는 초당 3개로 제한됩니다. 이 임계값을 초과하는 요청은 429 응답 코드를 반환합니다.
- API를 통해 키 값에 액세스할 수 없습니다. 권한이 없는 사용자는 보안 키 값에 액세스할 수 없습니다.
API 예시
보안 자격 증명을 뉴렐릭 계정으로 보내려면 보안 자격 증명을 설명하는 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 페이로드.
귀하의 뉴렐릭 계정에 있는 모든 보안 자격 증명 목록을 보려면 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
을 반환합니다.
뉴렐릭에서 기존 자격 증명을 업데이트하려면 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
을 반환합니다.
뉴렐릭에서 기존 자격 증명을 삭제하려면 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
지정된 키가 없으면 오류가 발생하지 않습니다.