Importante
Cada Atlas Administration API tem seus próprios recursos e requer configuração inicial.
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 Administration API 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 a recursos administrativos no Atlas. Para aprender mais sobre o Atlas Administration API, consulte Referência do Atlas Administration API.
A Administration API do Atlas não fornece acesso aos dados armazenados em seus clusters. Para ler ou gravar dados em um banco de dados, você deve autenticar em seu cluster usando as credenciais de um usuário de banco de dados com as funções de leitura ou gravação apropriadas. Você pode utilizar a Atlas Administration API para criar e gerenciar usuários de banco de dados.
Para usar a Administration API do Atlas para gerenciar seus clusters do Atlas, você deve autenticar suas solicitações de API com um dos seguintes métodos de autenticação:
Tokens de acesso à conta de serviço (OAuth 2.0)
Chaves de API (autenticação Digest HTTP)
Para saber mais sobre esses métodos, consulte Métodos de autenticação da Administration API do Atlas.
As seções a seguir descrevem como usar contas de serviço e chaves de API para configurar o acesso programático às suas organizações e projetos do Atlas.
Observação
O Modelo de responsabilidade compartilhada do MongoDB Atlas define os direitos complementares do MongoDB e de seus clientes em manter um ambiente de dados seguro e resiliente. Nesse framework, o MongoDB gerencia a segurança e a integridade operacional da plataforma subjacente, enquanto os clientes são responsáveis pelas políticas de configuração, gerenciamento e dados de suas implantações específicas. Para obter uma análise detalhada da propriedade em segurança e segurança operacional, consulte Modelo de responsabilidade compartilhada.
Acesso necessário
Para criar uma conta de serviço ou chaves de API para uma organização, você deve ter Organization Owner acesso a essa organização.
Para conceder acesso de uma conta de serviço a um projeto, você deve ter Organization Owner acesso à organização que possui o projeto.
Para conceder acesso de chaves de API a um projeto, você deve ter acessoProject Owner para esse projeto.
Opcional: Exigir uma lista de acesso IP
Quando você cria uma organização usando a IU do Atlas , o Atlas habilita automaticamente uma lista de acesso IP para a API de administração do Atlas . Isso limita as solicitações de API apenas às dos endereços IP ou CIDR baseados em local especificados na lista de acesso IP. Se você fizer uma solicitação à Atlas Administration API sem uma entrada da lista de acesso IP, o servidor responderá com um código de status 403.
Se você desabilitar esse recurso, poderá fazer solicitações de API de qualquer endereço na Internet, desde que a lista de acesso IP esteja vazia. Depois de adicionar uma entrada de lista de acesso IP , somente as solicitações originadas desse endereço IP podem fazer solicitações.
Observação
As listas de acesso IP se aplicam ao uso de tokens de acesso a contas de serviço, não à sua criação ou revogação. Você pode gerar um token a partir de qualquer endereço IP, mas só pode usá-lo para chamar a API se o seu endereço IP estiver na lista de acesso.
Para definir sua organização para exigir listas de acesso IP para cada solicitação da API de administração do Atlas após a criação da organização, siga estas etapas:
No Atlas, vá para a página Organization Settings.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Na barra lateral, clique em Organization Settings.
A página Configurações da organização é exibida.
Gerenciar Acesso Programático a uma Organização
Conceder acesso de programação a um projeto
Para aprender mais sobre esses dois métodos de autenticação, consulte Métodos de autenticação da Administration API do Atlas.
Para conceder acesso às chaves de API a um projeto, você deve ter acesso Project Access Manager ou Project Owner para esse projeto.
Adicionar acesso ao projeto de um projeto
Se você ainda não tiver criado uma conta de serviço ou chaves de API para uma organização, poderá criá-las para um projeto para conceder a esse projeto acesso à API de administração do Atlas. A conta de serviço ou as chaves de API que você cria para um projeto são adicionadas automaticamente à organização principal com a permissão Organization Member.
Fazer uma solicitação de API .
A Atlas Administration API usa um dos dois métodos de autenticação para autenticar solicitações: conta de serviço ou chaves de API. Você precisará das chaves ou do segredo que salvou ao configurar seu método de autenticação preferido para concluir os procedimentos a seguir.
Todos os endpoints do Atlas Administration API têm a seguinte URL base:
https://cloud.mongodb.com/api/atlas/<version>
Importante
O MongoDB utiliza URLs HTTPS para aumentar a segurança. O uso de URLs HTTP retornará um código de status 301.
Dica
Alternativamente, você pode usar qualquer ferramenta que suporte a especificação OpenAPI v3 para gerar exemplos de código ou servidores de simulação. Por exemplo, você pode importar a Especificação da API Admin do Atlas para o Postman para gerar comandos curl.
Aviso
Usar uma URL HTTP com o Postman retornará um código de status 301 como esperado. No entanto, neste cenário, o Postman pode automaticamente tentar novamente a solicitação com HTTPS, mas ao mesmo tempo remover o cabeçalho e o corpo da solicitação de nova tentativa. Isso retornará um código de status 401 em vez de 301, tornando difícil determinar por que a solicitação falhou.
Para usar o Postman para gerar comandos curl:
Na documentação da MongoDB Atlas Administration API, clique em Download source na barra de navegação.
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: