Skip to main content

Clés API du projet

Les clés API de projet sont indépendantes des utilisateurs et conviennent parfaitement aux outils d'automatisation et aux CI/CD. L'appartenance des utilisateurs à un projet peut évoluer au fil du temps, et les utilisateurs peuvent le quitter à tout moment. Si un utilisateur quitte le projet et que ses clés API ont été utilisées dans des fonctions du projet, ces clés perdront l'accès aux ressources du projet, ce qui entraînera des pannes d'automatisation imprévues. L'utilisation des clés API de projet et leur rotation au moment opportun permettent d'éviter ces scénarios.

Une clé API de projet donne accès aux ressources d'un projet, mais pas aux ressources permettant de gérer ou de posséder l'organisation ou les utilisateurs. Cela signifie qu'une clé API de projet ne peut pas être utilisée pour connaître les informations de facturation, ni pour inviter de nouveaux membres au projet ni pour créer de nouvelles clés API. Si une clé API de projet est compromise, elle peut être renouvelée par un membre du projet, ce qui réduit les risques.

Création de clés API de projet​

Les clés API du projet peuvent être obtenues en les créant dans la console Equinix Metal ou dans l'API elle-même.

Vous pouvez créer une clé API de projet dans les Paramètres du projet, sous l'onglet Clés API. Cliquez sur Ajouter une clé API. Entrez une description pour la clé et indiquez si elle a les autorisations Lecture/Écriture ou Lecture seule.

Creating a Project API key in the Console

Gestion des clés API du projet​

Les clés API d'un projet sont répertoriées dans l'onglet Clés API des Paramètres du projet.

Project API Keys List in the Console

Suppression des clés API du projet​

L'accès accordé via une clé API de projet peut être révoqué en supprimant cette clé. Cela n'affectera aucune des ressources créées avec cette clé.

Pour supprimer une clé API de la console, accédez à l'onglet Clés API des Paramètres du projet, puis cliquez sur Supprimer à côté de la clé que vous souhaitez supprimer.

Référence des points de terminaison​

Les clés API de projet ont un ensemble limité d'accès aux points de terminaison et sont limitées au projet dans lequel elles sont créées. Les clés API de projet peuvent effectuer les opérations suivantes:

Informations générales​

/capacity/metrosobtenir, poster
/operating-systemsobtenir /plans obtenir /projects/{id}/plans obtenir

Informations sur le projet​

/projectsobtenir, publier
/projects/{id}obtenir, mettre, supprimer /projects/{id}/batches obtenir /projects/{id}/customdata obtenir /projects/{id}/events obtenir /projects/{id}/licenses obtenir, publier
/projects/{id}/transfers publication /projects/{id}/usages obtenir /projects/{project_id}/invitations obtenir, publier /projects/{project_id}/membershipsobtenir

Informations sur les appareils​

/projects/{id}/devicesobtenir, publier
/projects/{id}/devices/batchpublication
/devices/{id} obtenir, mettre, supprimer /devices/{id}/actions publication /devices/{id}/bandwidth obtenir /devices/{id}/customdata obtenir /devices/{id}/events obtenir /devices/{id}/metadata obtenir /devices/{id}/traffic obtenir /devices/{id}/usagesobtenir /devices/{id}/userdata

Clés API​

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

Clés SSH​

/projects/{id}/ssh-keysobtenir, publier
/devices/{id}/ssh-keysobtenir
/ssh-keys obtenir
/ssh-keys publication
/ssh-keys/{id} obtenir, mettre, supprimer

Réservations de matériel​

/hardware-reservations/{id}obtenir /hardware-reservations/{id}/activate
/projects/{project_id}/self-service/reservations obtenir, publier /projects/{project_id}/self-service/reservations/{id} obtenir

Le marché au comptant​

/market/spot/pricesobtenir /market/spot/prices/history

Adresses IP​

/devices/{id}/ipsobtenir, publier
/ips/{id}obtenir, corriger, supprimer /ips/{id}/available obtenir /ips/{id}/customdata obtenir /projects/{id}/ips obtenir, publier
/projects/{project_id}/ips/{id}/customdata obtenir /devices/{instance_id}/ips/{id}/customdataobtenir

BGP​

/devices/{id}/bgp/neighborsobtenir
/projects/{id}/global-bgp-rangesobtenir
/projects/{id}/bgp-config obtenir, publier
/projects/{id}/bgp/sessions obtenir /devices/{id}/bgp/sessions obtenir, publier

Modes de réseau de couche 2 et VLAN​

/ports/{id}obtenir /ports/{id}/assign
/virtual-networks/{id} obtenir, supprimer
/projects/{id}/virtual-networks obtenir, publier
/ports/{id}/vlan-assignmentsobtenir /ports/{id}/vlan-assignments/{assignment_id}

Passerelles Metal​

/metal-gateways/{id}obtenir, supprimer /metal-gateways/{id}/ips
/projects/{project_id}/metal-gateways obtenir, publier

Interconnexion​

/connections/{connection_id}obtenir, mettre, supprimer
/connections/{connection_id}/eventsobtenir
/connections/{connection_id}/ports obtenir /connections/{connection_id}/virtual-circuits obtenir /connections/{connection_id}/ports/{id} obtenir /connections/{connection_id}/ports/{id}/events obtenir /connections/{connection_id}/ports/{port_id}/virtual-circuits obtenir, ports
/virtual-circuits/{id}/events obtenir /virtual-circuits/{id} obtenir, mettre, supprimer
/projects/{project_id}/connectionsobtenir, publier

VRF​

/projects/{id}/vrfsobtenir, publier
/vrfs/{id}obtenir, mettre, supprimer /vrfs/{id}/ips obtenir /vrfs/{vrf_id}/ips/{id} obtenir /vrfs/{id}/routes obtenir, publier
/routes/{id} obtenir, mettre, supprimer /routes/{id}/events obtenir
/metal-gateways/{id}/bgp-dynamic-neighbors obtenir, publier
/bgp-dynamic-neighbors/{id} obtenir, supprimer
Cette page vous a-t-elle été utile ?