プロジェクトAPIキー
プロジェクトAPIキーはユーザーから独立しており、自動化ツールやCI/CDに適している。ユーザーメンバーシップはプロジェクト内で時間の経過とともに変化する可能性があり、ユーザーはいつでもプロジェクトを離れることができる。APIキーがプロジェクト機能で使用されていたユーザーが離脱した場合、それらのキーはプロジェクトリソースへのアクセスを失い、その結果、計画外のオートメーション障害が発生する。プロジェクトのAPIキーを使用し、適切なタイミングでそれらのキーをローテーションすることで、このようなシナリオを回避することができる。
プロジェクトAPIキーは、プロジェクト内のリソースにアクセスできますが、組織やユーザーを管理したり所有したりできるリソースにはアクセスできません。つまり、プロジェクトAPIキーを使って請求の詳細を発見したり、新しいメンバーをプロジェクトに招待したり、新しいプロジェクトAPIキーを作成したりすることはできない。プロジェクトAPIキーが漏洩した場合、プロジェクトのメンバーによってローテーションされ、リスクを軽減することができます。
プロジェクトAPIキーの作成
プロジェクトのAPIキーは、Equinix MetalコンソールまたはAPI自体で作成することで取得できます。
- Console
- API
プロジェクト API キーは、Project Settings の API Keys タブで作成できます。Add an API Key をクリックします。キーの説明を追加し、パーミッションが_Read/Write_か_Read-only_かを選択します。

Project API キーを作成するには、/projects/{id}/api-keys エンドポイントに POST リクエストを送信します。ボディパラメータを使用して、説明を追加したり、キーを読み取り専用に設定します。
curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/projects/{id}/api-keys" \
-d '{
"description": "string",
"read_only": false
}'
プロジェクトAPIキーの管理
- Console
- API
プロジェクトのAPIキーは、_Project Settings_の_API Keys_タブに表示されます。

プロジェクトに関連付けられているすべての API キーを取得するには、/projects/{id}api-keys エンドポイントに GET リクエストを送信します。
curl -X GET -H 'X-Auth-Token: <API_TOKEN>' \
"https://api.equinix.com/metal/v1/projects/{id}/api-keys"
プロジェクトAPIキーの削除
プロジェクトAPIキーを使用して付与されたアクセスは、プロジェクトAPIキーを削除することで取り消すことができます。このキーで作成されたリソースには影響しません。
- Console
- API
コンソールからAPIキーを削除するには、_Project Settings_の_API Keys_タブに移動し、削除したいキーの横にあるDelete 。
API から API キーを削除するには、api-keys/{id} エンドポイントに DELETE リクエストを送信します。
curl -X DELETE -H 'X-Auth-Token: <API_TOKEN>' \
"https://api.equinix.com/metal/v1/api-keys/{id}"
エンドポイント・リファレンス
プロジェクトAPIキーは、エンドポイントへのアクセスが制限され、作成されたプロジェクトにスコープされます。プロジェクトAPIキーは以下のことができます:
一般情報
/capacity/metros | 取得、投稿 /operating-systems |
プロジェクト情報
/projects | 取得、ポスト /projects/{id} |
デバイス情報
/projects/{id}/devices | 取得、投稿 /projects/{id}/devices/batch |
APIキー
/api-keys/{id} | 削除 /projects/{id}/api-keys |
SSHキー
/projects/{id}/ssh-keys | 取得、投稿 /devices/{id}/ssh-keys |
ハードウェアの予約
/hardware-reservations/{id} | 取得 /hardware-reservations/{id}/activate |
スポット市場
/market/spot/prices | /market/spot/prices/historyを取得 |
IPアドレス
/devices/{id}/ips | 取得、投稿 /ips/{id} |
BGP
/devices/{id}/bgp/neighbors | /projects/{id}/global-bgp-rangesを取得 |
レイヤ2ネットワーキング・モードとVLAN
/ports/{id} | 取得 /ports/{id}/assign |
Metal ゲートウェイ
/metal-gateways/{id} | 取得、削除 /metal-gateways/{id}/ips |
インターコネクション
/connections/{connection_id} | 取得、配置、削除 /connections/{connection_id}/events |
VRF
/projects/{id}/vrfs | 取得、ポスト /vrfs/{id} |