Importante
Cada Atlas Administration API tem seus próprios recursos e requer configuração inicial.
You can access the Atlas Administration API servers through the public Internet only. The Atlas Administration API is not available over connections that use network peering or 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.
A Atlas Administration API 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 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.) 20
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
The MongoDB Atlas Shared Responsibility Model defines the complementary duties of MongoDB and its customers in maintaining a secure and resilient data environment. Under this framework, MongoDB manages the security and operational integrity of the underlying platform, while customers are responsible for the configuration, management, and data policies of their specific deployments. For a detailed breakdown of ownership across security and operational excellence, see Shared Responsibility Model.
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
To create a service account or API keys for an organization, you must have Organization Owner access to that organization.
Para conceder acesso de uma conta de serviço a um projeto, você deve ter Organization Owner acesso à organização que possui o projeto.
To grant API keys access to a project, you must have Project Owner access for that project.
Opcional: Exigir uma lista de acesso IP
Quando você cria uma organização usando a UI do Atlas , o Atlas exige 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 à API de administração do Atlas sem uma entrada da lista de acesso IP , o servidor responderá com um código de status 403.
If you disable this feature, you can make API requests from any address on the Internet as long as the IP access list is empty. Once you add an IP access list entry, only requests originating from that IP address can make requests.
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
As listas de acesso IP se aplicam apenas a chaves de API programáticas e contas de serviço. Elas não se aplicam a outros tipos de acesso à API de administração do Atlas , como o Atlas CLI ou o acesso delegado concedido por meio do Atlas App Connections. O acesso delegado inclui aplicativos de parceiros de terceiros, aplicativos MongoDB , como MongoDB Compass, e clientes do Model Context Protocol (MCP). Se a sua organização exige que todo o tráfego da API de Administração do Atlas seja originado de endereços específicos, não habilite o acesso delegado de aplicativos para essa organização. As configurações de acesso delegado para aplicativos parceiros e clientes MCP estão desativados por padrão nas 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.
To give API keys access to a project, you must have Project Access Manager or Project Owner access for that project.
Adicionar acesso ao projeto de um projeto
If you haven't already created a service account or API keys for an organization, you can create them for a project to grant that project access to the Atlas Administration API. The service account or API keys that you create for a project are automatically added to the parent organization with the permission Organization Member.
Solicitação API: como fazer
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 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
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 do Administrador do Atlas para o Postman para gerar curl comandos do.
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: