Clés API

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

Equinix Metal propose deux types de clés API :

• Clés API associées à des comptes d'utilisateurs spécifiques. Les clés API associées à un utilisateur disposent des mêmes autorisations pour tous les projets et organisations auxquels l'utilisateur 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 uniquement. Pour en savoir plus sur l'utilisation de Fabric, Network Edge et d'autres API Equinix, consultez /api-catalog.

Création de 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 API Keys de votre compte utilisateur, puis cliquez sur Add New Key. Ajoutez une description pour la clé, et choisissez si elle a des permissions Lecture/Ecriture 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 pour définir la clé 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    
}'

Gestion des clés d'API

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

Console

Vos clés API sont répertoriées dans l'onglet API Keys 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 les 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 d'API d'un autre utilisateur. Si vous devez supprimer l'accès d'un utilisateur à la clé API d'une organisation ou d'un projet, vous devrez supprimer son utilisateur de l'organisation ou du projet.

Console

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

API

Pour supprimer une clé 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"