Chaves de API do projeto

As chaves de API do projeto são independentes dos usuários e adequadas para ferramentas de automação e CI/CD. A associação de usuários pode mudar ao longo do tempo em um projeto, e os usuários podem sair de um projeto a qualquer momento. Se um usuário cujas chaves de API foram usadas em funções do projeto sair, essas chaves perderão o acesso aos recursos do projeto, resultando em falhas de automação não planejadas. Usando chaves de API do projeto e alternando-as no momento apropriado, esses cenários podem ser evitados.

Uma chave de API do Projeto tem acesso aos recursos dentro de um projeto, mas não aos recursos que podem gerenciar ou controlar a organização ou os usuários. Isso significa que uma chave de API do Projeto não pode ser usada para descobrir detalhes de cobrança, nem para convidar novos membros para o projeto ou criar novas chaves de API do Projeto. Se uma chave de API do Projeto for comprometida, ela poderá ser rotacionada por um membro do Projeto, reduzindo o risco.

Criando chaves de API do projeto

As chaves da API do projeto podem ser obtidas criando-as no console do Equinix Metal ou na própria API .

Console

Você pode criar uma chave de API do projeto nas Configurações do Projeto, na aba Chaves de API. Clique em **Adicionar uma chave de API **. 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 de projeto, envie uma solicitar POST para o endpoint /projects/{id}/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/projects/{id}/api-keys" \
-d '{
    "description": "string",
    "read_only": false    
}'

Gerenciando chaves de API do projeto

Console

As chaves de API de um projeto estão listadas na aba Chaves de API das Configurações do Projeto.

API

Para recuperar todas as chaves de API associadas a um Projeto, envie uma solicitar GET para o endpoint /projects/{id}api-keys.

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

Excluindo chaves de API do projeto

O acesso concedido usando uma chave de API do Projeto pode ser revogado excluindo a chave de API do Projeto. Isso não afetará nenhum dos recursos criados com a chave.

Console

Para excluir uma chave de API do console, acesse a guia Chaves de API nas Configurações do Projeto 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 api-keys/{id}.

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

Referência de endpoints

As chaves de API do projeto têm um conjunto limitado de acesso aos endpoints e são limitadas ao projeto em que são criadas. As chaves de API do projeto podem fazer o seguinte:

Informações gerais

/capacity/metros	obter, postar
/operating-systems	obter /plans

Informações do Projeto

/projects	obter, postar
/projects/{id}	obter, colocar, excluir /projects/{id}/batches
/projects/{id}/transfers	postagem /projects/{id}/usages

Informações sobre dispositivos

/projects/{id}/devices	obter, postar
/projects/{id}/devices/batch	postagem
/devices/{id}	obter, colocar, excluir /devices/{id}/actions

Chaves de API

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

Chaves SSH

/projects/{id}/ssh-keys	obter, postar
/devices/{id}/ssh-keys	obter
/ssh-keys	obter
/ssh-keys	postagem
/ssh-keys/{id}	obter, colocar, excluir

Reservas de Hardware

/hardware-reservations/{id}	obter /hardware-reservations/{id}/activate
/projects/{project_id}/self-service/reservations	obter, postar /projects/{project_id}/self-service/reservations/{id}

O Mercado Spot

/market/spot/prices	obter /market/spot/prices/history

Endereços IP

/devices/{id}/ips	obter, postar
/ips/{id}	obter, corrigir, excluir /ips/{id}/available
/projects/{project_id}/ips/{id}/customdata	obter /devices/{instance_id}/ips/{id}/customdata

BGP

/devices/{id}/bgp/neighbors	obter
/projects/{id}/global-bgp-ranges	obter
/projects/{id}/bgp-config	obter, postar
/projects/{id}/bgp/sessions	obter /devices/{id}/bgp/sessions

Modos de rede da Camada 2 e VLANs

/ports/{id}	obter /ports/{id}/assign
/virtual-networks/{id}	obter, excluir
/projects/{id}/virtual-networks	obter, postar
/ports/{id}/vlan-assignments	obter /ports/{id}/vlan-assignments/{assignment_id}

Portões de Metal

/metal-gateways/{id}	obter, excluir /metal-gateways/{id}/ips
/projects/{project_id}/metal-gateways	obter, postar

Interconexão

/connections/{connection_id}	obter, colocar, excluir
/connections/{connection_id}/events	obter
/connections/{connection_id}/ports	obter /connections/{connection_id}/virtual-circuits
/virtual-circuits/{id}/events	obter /virtual-circuits/{id}
/projects/{project_id}/connections	obter, postar

VRFs

/projects/{id}/vrfs	obter, postar
/vrfs/{id}	obter, colocar, excluir /vrfs/{id}/ips
/routes/{id}	obter, colocar, excluir /routes/{id}/events
/metal-gateways/{id}/bgp-dynamic-neighbors	obter, postar
/bgp-dynamic-neighbors/{id}	obter, excluir