このドキュメントには、 NerdGraph を使って、いくつかの New Relic API キーをプログラムで管理する方法のチュートリアルが含まれています。New Relic のキーに関する一般的な情報は、 API キー を参照してください。
機能説明の概要
API keys UI を使用して、キーを作成および管理することができます。あるいは、 NerdGraph's ApiAccess フィールドを使って、以下のタイプのキーをプログラムで作成・管理することもできます。
この機能の一般的な使用例としては、ライセンスキーを作成・管理し、セキュリティ目的でキーを回転させることができます。NerdGraphの機能を使って、元のライセンスキーを管理・削除することはできませんが、追加のライセンスキーを作成したり、作成したライセンスキーを管理することだけは可能です。
この機能についての注意事項
すべてのミューテーションは、複数のキーを引数として受け取ることができ、変更の成功とエラーに関する詳細を返します。詳細は以下の例を参照してください。
すべての変異（作成、更新、削除）は、
NrAuditEventの結果となり、監査目的で照会することができます。詳細については、 Audit events を参照してください。ライセンスキーについて
- ライセンスキーは、NerdGraphでは インジェストキー に分類されている。これは、主にデータのインジェストを可能にするためのものだからである。
- ライセンスキーの種類ごとに最大1,000個のキーを作成することができ、キーのローテーションが可能です。
- オリジナルのライセンスキーを管理・削除することはできず、追加のライセンスキーを作成したり、作成したキーを管理することのみが可能です。
使用例の前に
これらのサンプルクエリを使用する前に注意すべきことがあります。
- 以下の例では、ライセンスキー（別名インジェストキー）を使用していますが、インジェストキー固有のフィールドをユーザーキー固有のフィールドに置き換えて、同様の方法で ユーザーキー を照会することができます。
- データ構造を理解するには、 GraphiQL explorer を使って、クエリを試してみることをお勧めします。
- また、 UIを使ってユーザーキーの作成、閲覧、削除を行うことができます。
キーの作成
ヒント
NerdGraph GraphiQL explorer そのインターフェースの上部にある、ユーザーキーの検索と生成を行うことができます。
複数のアカウントとキータイプに対して、1回のミューテーションで複数のキー（ユーザーキーまたはライセンスキー）を作成すること。なお、ミューテーションでは、正常に作成されたキーだけでなく、キーの作成時に発生したエラーも返すことができます。
キーの作成例
mutation {
apiAccessCreateKeys(keys: {ingest: {accountId: YOUR_ACCOUNT_ID, ingestType:
BROWSER, name: "Browser Key", notes: "A note."}}) {
createdKeys {
id
key
name
notes
type
... on ApiAccessIngestKey {
ingestType
}
}
errors {
message
type
... on ApiAccessIngestKeyError {
accountId
errorType
ingestType
}
}
}
}結果はあなたのデータによって異なります。 GraphiQL explorer を使って、ミューテーションやクエリーを試してみてください。
このクエリを使って、 ユーザーキー を作成する例を示します。
キーの更新
アップデート・ミューテーションでは、キー文字列ではなく、キーIDを使ってキーを識別します。
mutation {
apiAccessUpdateKeys(keys: {ingest: {keyId: KEY_ID, name: "Updated name", notes:
"A new note!"}}) {
updatedKeys {
id
key
type
name
notes
}
errors {
message
}
}
}結果はあなたのデータによって異なります。 GraphiQL explorer を使って、ミューテーションやクエリーを試してみてください。
削除キー
削除変異では、キーの識別にキー文字列ではなくキーIDを使用します。削除されたキーは、New Relic システムへのアクセスが許可されなくなり、API アクセス GraphQL API への問い合わせで返されなくなります。
mutation {
apiAccessDeleteKeys(keys: {ingestKeyIds: INGEST_KEY_ID}) {
deletedKeys {
id
}
errors {
message
}
}
}結果はあなたのデータによって異なります。 GraphiQL explorer を使って、ミューテーションやクエリーを試してみてください。
検索キー
インジェストキーやユーザーキーにアクセスするには、アクターにスコープされた単一のキーまたはすべてのキーを照会します。単一のキーを照会する場合は、キーの ID とタイプ（INGEST または USER）を指定する必要があります。複数のキーを照会する場合は、キー検索を使用します。キー検索では、必須のタイプリストとオプションのスコープを使用して結果をフィルタリングします。他のユーザーに属するユーザーキーは、結果が難読化されます。
シングルキーの例のクエリです。
query {
actor {
apiAccess {
key(id: INGEST_KEY_ID, keyType: INGEST) {
key
name
type
... on ApiAccessIngestKey {
ingestType
}
}
}
}
}主要な検索例クエリ。
query { actor { apiAccess { keySearch(query: {types: INGEST, scope: {ingestTypes: BROWSER}}) { keys { name key type ... on ApiAccessIngestKey { ingestType } } } } }}結果はあなたのデータによって異なります。 GraphiQL explorer を使って、ミューテーションやクエリーを試してみてください。