Comece a usar a API de administração do Atlas
Nesta página
Importante
Cada Atlas Administration API tem seus próprios recursos e requer configuração inicial. O Atlas Administration API e o App Services Admin API também usam chaves de acesso diferentes do Data API.
Você pode acessar os servidores da API de administração do Atlas apenas pela internet pública. A API Atlas Administration não está disponível em conexões que usam emparelhamento de rede ou endpoints privados.
Para saber mais, consulte Atlas Programmatic Access.
A API de Administração do Atlas segue os princípios do estilo de arquitetura REST para expor uma série de recursos internos que permitem o acesso programático aos recursos do Atlas. Para saber mais, consulte Referência da API de Administração do Atlas.
Conceder acesso programático ao Atlas
Para conceder acesso programático a uma organização ou projeto usando apenas a API, crie uma chave de API.
As chaves API têm duas partes: uma chave pública e uma chave privada. Essas duas partes têm a mesma função que um nome de usuário e uma chave de API pessoal quando você faz solicitações de API ao Atlas.
Não é possível usar uma chave de API para fazer logon no Atlas por meio da interface do usuário.
Você deve conceder funções às chaves API como faria para os usuários garantir que as chaves API possam chamar endpoints API sem erros.
Todas as chaves de API pertencem à organização. Você pode conceder acesso a uma chave de API a um projeto. Para adicionar a nova chave de API a um projeto, Convide uma chave de API da organização para um projeto.
Cada chave API pertence a apenas uma organização, mas você pode conceder acesso a uma chave API a qualquer número de projetos nessa organização.
Necessário para todos os recursos: gerar uma chave de API da organização
Para acessar a API de administração do Atlas, crie uma chave de API em uma organização.
Todas as chaves de API pertencem à organização. Você pode conceder acesso a uma chave de API a um projeto. Para adicionar a nova chave API a um projeto, Convide uma chave da API da organização para um projeto.
Para saber mais sobre como gerenciar chaves de API para sua organização ou projeto, consulte Conceder acesso programático ao Atlas. Para obter detalhes de uso, consulte Fazer uma solicitação de API.
Opcional: Exigir uma lista de acesso IP para a API de administração do Atlas
O Atlas permite que suas chaves de API de administração do Atlas façam solicitações de qualquer endereço na internet, a não ser que você exija uma lista de acesso IP para a API de administração do Atlas. Se você precisar de uma lista de acesso de IP, suas chaves de API poderão fazer solicitações de API somente a partir dos endereços IP ou CIDR baseados em localização que você especificar na lista de acesso de IP.
Cada chave API tem sua própria lista de acesso IP. Se você precisar de uma lista de acesso IP para todas as solicitações de API do Atlas Administration, deverá definir pelo menos uma entrada da lista de acesso IP para uma chave de API antes de poder usar a chave de API.
Quando você cria uma nova organização usando a UI do Atlas, o Atlas habilita o requisito de lista de acesso à API por padrão. Para desabilitar o requisito de lista de acesso IP quando você criar uma organização, alterne Require IP Access List for the Atlas Administration API para OFF.
Para definir sua organização para exigir listas de acesso IP para cada chave do Atlas Administration API após a criação da organização, siga estas etapas:
Conecte-se
no Atlas.
Navegue até a página Settings da sua organização.
Se ainda não estiver exibido, selecione sua organização desejada no menu Organizations na barra de navegação.
Clique no ícone Organization Settings próximo ao menu Organizations.
Alterne a configuração Require IP Access List for the Atlas Administration API para On.
Exigir uma Lista de Acesso API para Todas as Solicitações
Você pode exigir que todas as solicitações de API de uma chave de API venham de uma entrada em sua lista de acesso à API. Se você precisar de listas de acesso à API, as chaves de API não poderão fazer solicitações de API até que você defina pelo menos uma entrada da lista de acesso à API.
Procedimento
Para definir sua organização para exigir listas de acesso API para cada chave API:
Conecte-se
no Atlas.
Navegue até a página Settings da sua organização.
Se ainda não estiver exibido, selecione sua organização desejada no menu Organizations na barra de navegação.
Clique no ícone Organization Settings próximo ao menu Organizations.
Alterne a configuração Require IP Access List for the Atlas Administration API para On.
Gerenciar Acesso Programático a uma Organização
Faça os procedimentos a seguir para conceder acesso de programação a uma organização. Para saber mais, consulte Gerenciar acesso programático a uma organização.
Acesso necessário
Para executar as seguintes ações, você deve ter acesso do Organization Owner ao Atlas.
Criar uma chave de API em uma organização
Conceder acesso de programação a um projeto
Siga os procedimentos a seguir para conceder acesso de programático a um projeto. Para saber mais, consulte Gerenciar acesso programático a um projeto.
Acesso necessário
Para executar qualquer uma das seguintes ações, você deve ter acesso do Project Owner ao projeto.
Adicionar uma chave de API da organização para um projeto
Criar uma chave de API para um projeto
Fazer uma Solicitação API
A API de Administração do Atlas utiliza Autenticação Digest HTTP para autenticar pedidos. Ao criar uma solicitação HTTP , você deve fornecer a chave pública da API programática e a chave privada correspondente como nome de usuário e senha. Para saber como configurar o acesso à API para um projeto do Atlas, consulte Conceder acesso programático ao Atlas.
Todos os endpoints do Atlas Administration API têm a seguinte URL base:
https://cloud.mongodb.com/api/atlas/<version>
Exemplo de solicitação de API
Sua solicitação deve se parecer com os exemplos a seguir, em que {PUBLIC-KEY} é a chave pública da API e {PRIVATE-KEY} é a chave privada correspondente.
A seguinte amostra de solicitação GET retorna todos os projetos na sua organização:
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Content-Type: application/json" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ --include \ --request GET "https://cloud.mongodb.com/api/atlas/v2/groups"
A seguinte amostra de solicitação POST recebe um corpo da solicitação e cria um projeto denominado MyProject na sua organização:
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Content-Type: application/json" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ --include \ --request POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ --data ' { "name": "MyProject", "orgId": "5a0a1e7e0f2912c554080adc" }'
Dica
Como alternativa, você pode usar qualquer ferramenta compatível com OpenAPI v3 especificação para gerar amostras de código ou servidores mock. Por exemplo, você pode importar a Especificação da API do Atlas Admin para o Postman para gerar curl comandos. Para usar o Postman para gerar curl comandos :
Na documentação da API de Administração do MongoDB Atlas, clique com o botão direito em Baixar e copie o link.
Abra o Postman e clique em Arquivo, depois em Importar.
A janela Importar é exibida.
Na janela Importar , clique em Link e cole o link de download que você copiou na etapa 1.
Clique em Continuar e, em seguida, em Importar.
Para a solicitação para a qual você deseja gerar um comando curl , clique em </> à direita e selecione cURL na lista suspensa Trecho de código .
Próximos passos
Para saber mais sobre a API de Administração do Atlas, consulte Referência da API de administração do Atlas.
Para gerenciar o acesso de programação à API de administração do Atlas, consulte qualquer um dos seguintes procedimentos: