Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.
Menu Docs

Acesso programático AtlasGov

MongoDB Atlas for Government supports programmatic access using the following resources. However, AtlasGov is designed with additional security, compliance, and operational considerations to meet the needs of organizations that handle sensitive data. To learn more about how these considerations impact feature availability, see Atlas for Government Considerations.

O AtlasGov é compatível com as seguintes ferramentas DevOps:

produto
Descrição

Gerencie recursos do Atlas juntamente com seus aplicativos baseados em Kubernetes, por meio do seu fluxo de trabalho Kubernetes existente.

Integre o Atlas em seus fluxos de trabalho de entrega contínua com o HashiCorp Terraform MongoDB Atlas Provider.

A API MongoDB Atlas for Government funciona da mesma forma que a API Atlas, exceto pelo fato de que ela usa a seguinte URL base:

https://cloud.mongodbgov.com/api/atlas/v2

Para usar a API do MongoDB Atlas for Government para gerenciar seus clusters, você deve autenticar suas solicitações de API. A API do MongoDB Atlas for Government aceita os seguintes métodos de autenticação:

Importante

Recomendamos que você use contas de serviço em vez de chaves de API para autenticar na API do MongoDB Atlas for Government. As chaves de API são um método de autenticação legado.

Este exemplo do curl recupera usuários do banco de dados para um projeto. Selecione a aba apropriada para o método de autenticação de sua preferência:

Para fazer uma solicitação de API usando uma conta de serviço, use a conta de serviço para gerar um token de acesso e, em seguida, use o token de acesso em sua solicitação:

1

Localize o segredo do cliente que começa com mdb_sa_sk_ que você salvou imediatamente após criar a conta de serviço. Se você não salvou o segredo do cliente , deverá gerar um novo segredo do cliente .

2

Por exemplo, execute:

echo -n {clientId}:{clientSecret} | base64
3

Importante

O token de acesso é válido por 1 hora (3600 segundos). Você não pode atualizar um token de acesso. Quando esse token de acesso expirar, repita essa etapa para gerar um novo.

Substitua {base64Auth} no exemplo a seguir pela saída da etapa anterior e execute:

1curl --request POST \
2 --url https://cloud.mongodbgov.com/api/oauth/token \
3 --header 'accept: application/json' \
4 --header 'cache-control: no-cache' \
5 --header 'authorization: Basic {base64Auth}' \
6 --header 'content-type: application/x-www-form-urlencoded' \
7 --data 'grant_type=client_credentials'
4

Substitua {accessToken} no exemplo a seguir pela saída da etapa anterior.

A seguinte amostra de solicitação GET retorna todos os projetos na sua organização:

curl --request GET \
--url https://cloudgov.mongodb.com/api/atlas/v2/groups \
--header 'Authorization: Bearer {accessToken}' \
--header 'Accept: application/vnd.atlas.2023-02-01+json' \
--header 'Content-Type: application/json'

The following sample POST request takes a request body and creates a project named MyProject in your organization:

curl --header 'Authorization: Bearer {accessToken}' \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.atlas.2023-02-01+json" \
--include \
--request POST "https://cloudgov.mongodb.com/api/atlas/v2/groups" \
--data '
{
"name": "MyProject",
"orgId": "5a0a1e7e0f2912c554080adc"
}'

To make an API request using API keys, replace {publicKey}:{privateKey} with your API keys and run:

curl --user "{publicKey}:{privateKey}" --digest \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--header "Accept: application/vnd.atlas.2025-03-12+json" \ # update date to desired API version
--include \
--request GET "https://cloud.mongodbgov.com/api/atlas/v2/groups/{projectId}/databaseUsers?pretty=true"
  • Você pode encontrar seu projectId em seu Project Settings.

  • You can generate an API key pair in your organization's Access Manager, under the API Keys tab.

Você deve designar projetos para uso padrão ou governamental (gov) da região após a criação. Você não pode implantar clusters entre regiões governamentais e padrão no mesmo projeto.

Por padrão, a API do AtlasGov designa novos projetos para uso padrão da região.

Para usar a API para criar um projeto para regiões governamentais, inclua o seguinte em seus dados de solicitação do POST :

"regionUsageRestrictions" : "GOV_REGIONS_ONLY"

Dica

Documentação do Atlas

Para obter informações detalhadas sobre como criar um projeto com a API, incluindo uma solicitação de exemplo , consulte Criar um projeto.

Os seguintes fornecedores de nuvem, produtos MongoDB e funcionalidades não estão disponíveis para todos os recursos de API :

  • Azure

  • Atlas Online Archives

  • Atlas Triggers

  • MongoDB Charts

  • Atlas Device SDKs

  • Clusters gratuitos, flexíveis e M10

Muitos dos recursos comerciais da API do Atlas são limitados ou indisponíveis:

Database users who authenticate with SCRAM must use SCRAM-SHA-256.

Os clusters do AtlasGov devem ser de nível M20 ou superior. O Atlas não suporta clusters Free e Flex.

  • Os alertas relacionados às formas de pagamento não estão disponíveis.

  • Os alertas podem vir de vários endereços de e-mail diferentes. Para obter mais informações, consulte alerta e comunicações.

You must have the Project Owner role to configure a third-party monitoring integration.

Quando integrado ao Datadog, o AtlasGov usa o site Datadog for Government (US1-FED).

Para saber mais sobre US1-FED, consulte a documentação DataDog.

Restaurações entre projetos padrão e projetos somente da região Gov não são permitidas. Se você criar um backup de um cluster em um projeto somente de região Gov (AWS GovCloud ou GCP Assured Workloads), poderá restaurar os dados para um cluster somente em um projeto somente de região Gov. A mesma restrição se aplica a projetos padrão, em que backups em regiões padrão só podem ser restaurados em clusters em projetos padrão.

A restauração entre nuvens é suportada entre as regiões Amazon Web Services GovCloud e GCP Assured Workloads.

Os clusters flexíveis não estão disponíveis no AtlasGov.

Os Arquivos Online não estão disponíveis no AtlasGov.

  • Você pode emparelhar regiões da AWS GovCloud com clusters MongoDB somente em regiões da AWS GovCloud. Você pode realizar o emparelhamento de regiões comerciais da AWS com clusters MongoDB somente em regiões comerciais da AWS.

  • Você pode emparelhar regiões de cargas de trabalho garantidas do GCP com clusters MongoDB somente em regiões de cargas de trabalho garantidas do GCP.

  • Você pode vincular regiões da AWS GovCloud a clusters MongoDB somente em regiões da AWS GovCloud. Você pode vincular regiões comerciais da AWS a clusters do MongoDB somente em regiões comerciais da AWS.

  • Você pode vincular regiões de cargas de trabalho garantidas do GCP a clusters MongoDB apenas em regiões de cargas de trabalho garantidas do GCP.

Além do registro padrão do Atlas, o AtlasGov registra o nome de usuário e o endereço IP associados a todas as tentativas fracassadas de login, bloqueios temporários e autenticações de resumo da API com falha.

  • Você deve usar chaves KMS nas regiões do Amazon Web Services GovCloud e GCP Assured Workloads para criptografar dados em projetos somente da região do Amazon Web Services GovCloud e GCP Assured Workloads. Você deve usar chaves KMS em regiões comerciais do Amazon Web Services para criptografar dados em projetos somente de região comercial do Amazon Web Services.

Você não pode criar o MongoDB Atlas para usuários do governo. O MongoDB Atlas for Government está disponível apenas por convite.

Atlas Stream Processing não está disponível no AtlasGov.

Os Atlas Triggers não estão disponíveis no AtlasGov.