Claves API

Su clave API proporciona autenticación a la Equinix Metal™ API y a las herramientas y servicios que se construyen sobre ella, como el metal-cli o nuestro [proveedor Terraform.

Equinix Metal ofrece dos tipos diferentes de claves API:

• Claves API asociadas a cuentas de usuario específicas. Las claves API asociadas a usuarios tienen todos los mismos permisos en todos los Proyectos y Organizaciones a los que el usuario tiene acceso.
• Project API keys which are associated with a specific Project. Project API keys can only be used to access resources within that project.

Puede limitar ambos tipos de claves al acceso de sólo lectura en el momento de la creación.

Nota: Las claves API creadas y gestionadas en Equinix Metal están limitadas únicamente a Equinix Metal. Obtenga más información sobre el uso de Fabric, Network Edge y otras API de Equinix en /api-catalog.

Creación de claves API

Puede crear una clave API para su usuario en la consola de Equinix Metal o a través de la propia API. Puede crear varias claves para su cuenta de usuario.

Console

Para crear una clave API en la consola, vaya a la pestaña Claves API de su cuenta de usuario y haga clic en Añadir nueva clave. Añada una descripción para la clave y elija si tiene permisos de Lectura/Escritura o Sólo lectura.

API

Para crear una clave API asociada a su cuenta de usuario, envíe una solicitud POST al punto final /user/api-keys. Utilice los parámetros del cuerpo para añadir una descripción o para establecer la clave como de sólo lectura.

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    
}'

Gestión de sus claves API

Sólo puede gestionar las claves API de usuario asociadas a su propia cuenta de usuario. No puede gestionar las claves API de ningún otro usuario.

Console

Sus claves API aparecen en la pestaña Claves API de su cuenta de usuario.

API

Para recuperar todas las claves API asociadas a su cuenta de usuario, envíe una solicitud GET al punto final /user/api-keys.

curl -X GET -H 'X-Auth-Token: <API_TOKEN>' \
"https://api.equinix.com/metal/v1/user/{id}/api-keys"

Borrar sus claves API

Las claves API pueden eliminarse sin que ello afecte a ninguno de los recursos creados con ellas.

Nota: Las claves API que están asociadas a usuarios no pueden gestionarse a nivel de Organización o Proyecto. No podrá gestionar las claves API de ningún otro usuario. Si necesita eliminar el acceso a la clave API de un usuario de una Organización o Proyecto, tendrá que eliminar su usuario de la Organización o Proyecto.

Console

Para eliminar una clave API desde la consola, vaya a la pestaña Claves API de su cuenta de usuario y haga clic en Eliminar junto a la clave que desee eliminar.

API

Para eliminar una clave de la API, envíe una solicitud DELETE al punto final /user/{id}/api-keys.

curl -X DELETE -H 'X-Auth-Token: <API_TOKEN>' \
"https://api.equinix.com/metal/v1/user/{id}/api-keys"