Claves API del proyecto

Las claves API de los proyectos son independientes de los usuarios y se adaptan bien a las herramientas de automatización y CI/CD. La pertenencia a un usuario puede cambiar con el tiempo en un proyecto, y los usuarios pueden abandonarlo en cualquier momento. Si se marcha un usuario cuyas claves API se utilizaban en funciones del proyecto, dichas claves perderán el acceso a los recursos del proyecto, lo que provocará fallos de automatización imprevistos. Utilizando claves API del proyecto, y rotando esas claves en el momento adecuado, se pueden evitar estos escenarios.

Una clave API de proyecto tiene acceso a los recursos dentro de un proyecto, pero no a los recursos que pueden gestionar o poseer la organización o los usuarios. Esto significa que una clave API de proyecto no puede utilizarse para descubrir detalles de facturación, ni para invitar a nuevos miembros al proyecto o crear nuevas claves API de proyecto. Si una clave API de proyecto se ve comprometida, puede ser rotada por un miembro del proyecto, lo que reduce el riesgo.

Creación de claves API de proyecto

Las claves API del proyecto pueden obtenerse creándolas en la consola de Equinix Metal o en la propia API.

Console

Puede crear una clave API del proyecto en la Configuración del proyecto, en la pestaña Claves API. Haga clic en Añadir una clave API. 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 de proyecto, envíe una solicitud POST al punto final /projects/{id}/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/projects/{id}/api-keys" \
-d '{
    "description": "string",
    "read_only": false    
}'

Gestión de las claves API del proyecto

Console

Las claves API de un proyecto se enumeran en la pestaña Claves API de la Configuración del proyecto.

API

Para recuperar todas las claves API asociadas a un proyecto, envíe una solicitud GET al punto final /projects/{id}api-keys.

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

Eliminación de claves API de proyecto

El acceso concedido mediante una clave API de proyecto puede revocarse eliminando la clave API de proyecto. Esto no afectará a ninguno de los recursos creados con la clave.

Console

Para eliminar una clave API desde la consola, vaya a la pestaña Claves API de la Configuración del proyecto, 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 api-keys/{id}.

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

Puntos finales Referencia

Las claves API de proyecto tienen un conjunto limitado de accesos a los puntos finales y se limitan al proyecto en el que se crean. Las claves API de proyecto pueden hacer lo siguiente:

Información general

/capacity/metros	get, post /operating-systems

Información sobre el proyecto

/projects	get, post /projects/{id}

Información sobre dispositivos

/projects/{id}/devices	get, post /projects/{id}/devices/batch

Claves API

/api-keys/{id}	eliminar /projects/{id}/api-keys

Claves SSH

/projects/{id}/ssh-keys	get, post /devices/{id}/ssh-keys

Reservas de hardware

/hardware-reservations/{id}	get /hardware-reservations/{id}/activate

El mercado al contado

/market/spot/prices	get /market/spot/prices/history

Direcciones IP

/devices/{id}/ips	obtener, publicar /ips/{id}

BGP

/devices/{id}/bgp/neighbors	get /projects/{id}/global-bgp-ranges

Modos de red de capa 2 y VLAN

/ports/{id}	get /ports/{id}/assign

Pasarelas metálicas

/metal-gateways/{id}	get, delete /metal-gateways/{id}/ips

Interconexión

/connections/{connection_id}	get, put, delete /connections/{connection_id}/events

VRFs

/projects/{id}/vrfs	get, post /vrfs/{id}