Clés API

Votre clé API permet l'authentification auprès de l'API Equinix Metal™ et des outils et services qui sont construits dessus, tels que metal-cli ou notre [fournisseur Terraform.

Equinix Metal propose deux types différents de clés API:

• Clés API associées à des comptes utilisateurs spécifiques. Les clés API associées à un utilisateur disposent des mêmes autorisations pour tous les projets et organisations auxquels il a accès.
• Project API keys which are associated with a specific Project. Project API keys can only be used to access resources within that project.

Vous pouvez limiter les deux types de clés à un accès en lecture seule au moment de la création.

Remarque: Les clés API créées et gérées dans Equinix Metal sont limitées à Equinix Metal. Pour en savoir plus sur l’utilisation des API Fabric, Network Edge et autres API Equinix, consultez le catalogue des API (/api-catalog).

Créer vos clés API

Vous pouvez créer une clé API pour votre utilisateur dans la console Equinix Metal ou via l'API elle-même. Vous pouvez créer plusieurs clés pour votre compte utilisateur.

Console

Pour créer une clé API dans la console, accédez à l'onglet Clés API de votre compte utilisateur et cliquez sur Ajouter une nouvelle clé. Entrez une description pour la clé et indiquez si elle a les autorisations Lecture/Écriture ou Lecture seule.

API

Pour créer une clé API associée à votre compte utilisateur, envoyez une requête POST au point de terminaison /user/api-keys. Utilisez les paramètres du corps pour ajouter une description ou définir la clé comme étant en lecture seule.

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

Gérer vos clés API

Vous ne pouvez gérer que les clés API utilisateur associées à votre propre compte utilisateur. Vous ne pouvez pas gérer les clés API d'autres utilisateurs.

Console

Vos clés API sont répertoriées dans l'onglet Clés API de votre compte utilisateur.

API

Pour récupérer toutes les clés API associées à votre compte utilisateur, envoyez une requête GET au point de terminaison /user/api-keys.

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

Suppression de vos clés API

Les clés API peuvent être supprimées sans affecter aucune des ressources créées avec elles.

Remarque: Les clés API associées aux utilisateurs ne peuvent pas être gérées au niveau de l’organisation ou du projet. Vous ne pouvez pas gérer les clés API des autres utilisateurs. Si vous souhaitez supprimer l’accès d’un utilisateur à une clé API au sein d’une organisation ou d’un projet, vous devrez supprimer cet utilisateur de l’organisation ou du projet.

Console

Pour supprimer une clé API de la console, accédez à l'onglet Clés API de votre compte utilisateur et cliquez sur Supprimer à côté de la clé que vous souhaitez supprimer.

API

Pour supprimer une clé API de l'API, envoyez une requête DELETE au point de terminaison /user/{id}/api-keys.

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