Chaves de API

Sua chave de API fornece autenticação para a API Equinix Metal ™ e para as ferramentas e serviços construídos sobre ela, como o metal-cli ou nosso provedor Terraform .

O Equinix Metal oferece dois tipos diferentes de chaves de API:

• Chaves de API associadas a contas de usuário específicas. As chaves de API associadas ao usuário têm as mesmas permissões em todos os Projetos e Organizações aos quais o usuário tem acesso .
• Project API keys which are associated with a specific Project. Project API keys can only be used to access resources within that project.

Você pode limitar ambos os tipos de chaves ao acesso somente leitura no momento da criação.

Observação: As chaves de API criadas e gerenciadas no Equinix Metal têm escopo apenas para o Equinix Metal . Saiba mais sobre como usar o Fabric, o Network Edge e outras APIs da Equinix em /api-catalog.

Criando suas chaves de API

Você pode criar uma chave de API para seu usuário no console do Equinix Metal ou pela própria API . Você pode criar várias chaves para sua conta de usuário .

Console

Para criar uma chave de API no console, acesse a guia Chaves de API da sua conta de usuário e clique em Adicionar nova chave. Adicione uma descrição para a chave e escolha se ela terá permissões de Leitura/Gravação ou Somente leitura.

API

Para criar uma chave de API associada à sua conta de usuário, envie uma solicitar POST para o endpoint /user/api-keys. Use os parâmetros do corpo para adicionar uma descrição ou para definir a chave como somente leitura.

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

Gerenciando suas chaves de API

Você só pode gerenciar as Chaves de API de Usuário associadas à sua própria conta de usuário . Você não pode gerenciar as Chaves de API de outros usuários.

Console

Suas chaves de API estão listadas na aba Chaves de API da sua conta de usuário .

API

Para recuperar todas as chaves de API associadas à sua conta de usuário, envie uma solicitar GET para o endpoint /user/api-keys.

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

Excluindo suas chaves de API

As chaves de API podem ser excluídas sem afetar nenhum dos recursos criados com elas.

Observação: As chaves de API associadas a usuários não podem ser gerenciadas no nível da Organização ou do Projeto. Você não pode gerenciar as chaves de API de outros usuários. Se você remover o acesso à chave de API de um usuário de uma Organização ou Projeto, você terá que remover o usuário da Organização ou do Projeto.

Console

Para excluir uma chave de API do console, acesse a guia Chaves de API da sua conta de usuário e clique em Excluir ao lado da chave que deseja excluir.

API

Para excluir uma chave de API da API, envie uma solicitar DELETE para o endpoint /user/{id}/api-keys.

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