Importante
Cada Atlas Administration API tem seus próprios recursos e requer configuração inicial.
Você pode acessar os servidores da Atlas Administration API apenas pela internet pública. A Atlas Administration API não está disponível em conexões que usam emparelhamento de rede ou private endpoints.
Para saber mais, consulte Atlas Programmatic Access.
A Atlas Administration API 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 saber mais sobre a Atlas Administration API, consulte Referência da Atlas Administration API.
The Atlas Administration API doesn't provide access to the data stored in your clusters. To read or write data in a database, you must authenticate to your cluster using the credentials for a database user with the appropriate read or write roles. You can use the Atlas Administration API to create and manage database users.
Para usar a Atlas Administration API 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
Antes de começar
Antes de configurar o acesso programático, confirme o seguinte:
Você tem uma conta Atlas. Para criar um, consulte Criar uma Conta Atlas.
Uma organização Atlas existe. Para criar uma, consulte Criar uma organização.
Acesso necessário
Para criar uma conta de serviço ou chaves de API para uma organização, você deve ter acesso Organization Owner 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 às chaves de API acesso a um projeto, você deve ter acesso Project Owner para esse projeto.
Opcional: Exigir uma lista de acesso IP
Ao criar uma organização usando a IU do Atlas, o Atlas exige uma lista de acesso IP para a Atlas Administration API. Isso limita as solicitações de API apenas àquelas provenientes de endereços IP baseados em localização ou endereços CIDR que você especifica na lista de acesso IP. Se você fizer uma solicitação à Atlas Administration API sem uma entrada na lista de acesso IP, o servidor responderá com um código de status 403.
Se você desativar este recurso, poderá fazer solicitações de API de qualquer endereço na Internet, desde que a lista de acesso IP esteja vazia. Uma vez que você adiciona uma entrada na lista de acesso IP, apenas 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.
Observação
lista de acesso IP aplicam-se apenas a chaves de API programáticas e contas de serviço. Eles não se aplicam a outros tipos de acesso à Atlas Administration API, como a Atlas CLI ou acesso delegado concedido por meio de Atlas App Connections. Acesso delegado inclui aplicativo de parceiro de terceiros, aplicativo MongoDB como o MongoDB Compass e cliente do Model Context protocolo (MCP). Se sua organização exigir que todo o tráfego da Atlas Administration API se origine de endereços específicos, não ative o acesso delegado de aplicativo para essa organização. As configurações de acesso delegado para aplicativos parceiros e clientes MCP estão desativadas por padrão em organizações existentes.
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, acesse 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 dar acesso às chaves de API a um projeto, você deve ter o acesso Project Access Manager ou Project Owner a esse projeto.
Adicionar acesso ao projeto de um projeto
Se você ainda não criou uma conta de serviço ou chaves de API para uma organização, pode criá-las para um projeto e conceder a esse projeto acesso à Atlas Administration API. A conta de serviço ou as chaves de API que você cria para um projeto são automaticamente adicionadas à organização principal com a permissão Organization Member.
Fazer uma Solicitação 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 o método de autenticação preferido para concluir os procedimentos a seguir.
Todos os pontos de extremidade 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
Como alternativa, você pode usar qualquer ferramenta que ofereça especificação OpenAPI v3 para gerar amostras de código ou servidores fictícios. 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:
In the MongoDB Atlas Administration API documentation, click Download source in the navigation bar.
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: