APIキー
お客様のAPIキーは、Equinix Metal™ API、およびその上に構築されたツールやサービス（metal-cliや当社のTerraformプロバイダなど）に対する認証となります。
エクイニクスメタルは2種類のAPIキーを提供しています：
- 特定のユーザーアカウントに関連付けられた API キー。ユーザーに関連付けられているAPIキーは、そのユーザーがアクセスできるすべてのプロジェクトと組織にわたって、すべて同じ権限を持ちます。
- Project API keys which are associated with a specific Project. Project API keys can only be used to access resources within that project.
どちらのタイプの鍵も、作成時に読み取り専用アクセスに制限することができる。
注： Equinix Metalで作成・管理されるAPIキーは、Equinix Metalのみにスコープされます。Fabric、Network Edge、その他のエクイニクスAPIの利用方法については、/api-catalogをご覧ください。
APIキーの作成
ユーザーのAPIキーは、Equinix MetalコンソールまたはAPIから作成できます。ユーザーアカウントには複数のキーを作成できます。
- Console
- API
コンソールで API キーを作成するには、ユーザーアカウントの API Keys タブに移動し、Add New Key をクリックします。キーの説明を追加し、Read/Write または Read-only のどちらのパーミッションを持つかを選択します。
ユーザーアカウントに関連付けられた API キーを作成するには、/user/api-keys エンドポイントに POST リクエストを送信します。ボディパラメータを使用して、説明を追加するか、キーを読み取り専用に設定します。
curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/user/api-keys" \
-d '{
"description": "string",
"read_only": false
}'
APIキーの管理
管理できるのは、自分のユーザーアカウントに関連付けられているユーザーAPIキーのみです。他のユーザーのAPIキーを管理することはできません。
- Console
- API
APIキーは、ユーザーアカウントの_APIキー_タブにリストされています。
ユーザーアカウントに関連付けられているすべての API キーを取得するには、/user/api-keys エンドポイントに GET リクエストを送信します。
curl -X GET -H 'X-Auth-Token: <API_TOKEN>' \
"https://api.equinix.com/metal/v1/user/{id}/api-keys"
APIキーの削除
APIキーは、そのキーで作成されたリソースに影響を与えることなく削除することができる。
注： ユーザーに関連付けられている API キーは、組織またはプロジェクト レベルでは管理できません。他のユーザーのAPIキーを管理することはできません。組織またはプロジェクトからユーザーのAPIキーアクセスを削除する必要がある場合は、組織またはプロジェクトからそのユーザーを削除する必要があります。
- Console
- API
コンソールから API キーを削除するには、ユーザーアカウントの API Keys タブに移動し、削除するキーの横にあるDelete をクリックします。
API から API キーを削除するには、/user/{id}/api-keys エンドポイントに DELETE リクエストを送信します。
curl -X DELETE -H 'X-Auth-Token: <API_TOKEN>' \
"https://api.equinix.com/metal/v1/user/{id}/api-keys"