API 密钥

您的 API 密钥为 Equinix Metal™ API 以及构建在其上的工具和服务（例如 metal-cli 或我们的 Terraform 提供程序）提供身份验证。

Equinix Metal提供两种不同类型的 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 和其他 Equinix API 的更多信息，请访问 /api-catalog。

创建您的 API 密钥

您可以在Equinix Metal控制台或 API 本身为您的用户创建 API 密钥。您可以为您的用户帐户创建多个密钥。

Console

要在控制台中创建 API 密钥，请导航至用户帐户的“API 密钥”选项卡，然后单击“添加新密钥”。添加密钥描述，并选择其权限是“读/写”还是“只读”。

API

要创建与您的用户帐户关联的 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

要从 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"