本文へスキップ

プロジェクトAPIキー

プロジェクトAPIキーはユーザーから独立しており、自動化ツールやCI/CDに適している。ユーザーメンバーシップはプロジェクト内で時間の経過とともに変化する可能性があり、ユーザーはいつでもプロジェクトを離れることができる。APIキーがプロジェクト機能で使用されていたユーザーが離脱した場合、それらのキーはプロジェクトリソースへのアクセスを失い、その結果、計画外のオートメーション障害が発生する。プロジェクトのAPIキーを使用し、適切なタイミングでそれらのキーをローテーションすることで、このようなシナリオを回避することができる。

プロジェクトAPIキーは、プロジェクト内のリソースにアクセスできますが、組織やユーザーを管理したり所有したりできるリソースにはアクセスできません。つまり、プロジェクトAPIキーを使って請求の詳細を発見したり、新しいメンバーをプロジェクトに招待したり、新しいプロジェクトAPIキーを作成したりすることはできない。プロジェクトAPIキーが漏洩した場合、プロジェクトのメンバーによってローテーションされ、リスクを軽減することができます。

プロジェクトAPIキーの作成

プロジェクトのAPIキーは、Equinix MetalコンソールまたはAPI自体で作成することで取得できます。

プロジェクト API キーは、Project SettingsAPI Keys タブで作成できます。Add an API Key をクリックします。キーの説明を追加し、パーミッションが_Read/Write_か_Read-only_かを選択します。

Creating a Project API key in the Console

プロジェクトAPIキーの管理

プロジェクトのAPIキーは、_Project Settings_の_API Keys_タブに表示されます。

Project API Keys List in the Console

プロジェクトAPIキーの削除

プロジェクトAPIキーを使用して付与されたアクセスは、プロジェクトAPIキーを削除することで取り消すことができます。このキーで作成されたリソースには影響しません。

コンソールからAPIキーを削除するには、_Project Settings_の_API Keys_タブに移動し、削除したいキーの横にあるDelete

エンドポイント・リファレンス

プロジェクト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}
このページは役に立ちましたか?