MongoDB Atlas App Services Admin API
3.0

URL base

https://services.cloud.mongodb.com/api/admin/v3.0

A App Services Admin API permite que você execute tarefas administrativas por meio de código de programação por HTTPS. Isso inclui definir e configurar aspectos como:

Sistema e segurança de aplicativos
APIs e endpoints
Autenticação e gerenciamento de usuários
Fontes de dados
Device Sync
Ambientes
Funções
Registros
Regras
Schemas
Hospedagem estática
Acionadores
Métricas de uso e faturamento
Values & Secrets

A API de administração é para desenvolvimento, configuração e implantação de aplicação . Para usar os recursos que você configura com a API de administração, os aplicativos do cliente se conectam a uma API HTTPS específica do seu aplicativo.

IDs de projeto e aplicativo

Observação: Os termos ID do projeto e ID do grupo são intercambiáveis.

Os endpoints da API de administração do Atlas App Services frequentemente exigem que você inclua dois parâmetros no URL:

Seu ID de projeto Atlas (às vezes também chamado de ID de grupo)
Seu ID do aplicativo App Services

ID do Projeto

Você pode encontrar seu ID do projeto no painel do MongoDB Atlas ou com a CLI do MongoDB Atlas.

ID do aplicativo

Para localizar um ID de aplicativo, faça uma solicitação ao endpoint List Apps do seu projeto. Você precisará de um access_token para fazer essa solicitação. Para saber como obter um, consulte Obter um token de acesso à sessão da API Admin.

curl --request GET \
  --header 'Authorization: Bearer <access_token>' \
  https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps

Isso retornará uma lista de objetos que descrevem cada aplicativo do App Services no projeto/grupo fornecido. Para solicitações de API Admin, seu ID do aplicativo é o valor ObjectId no campo _id , não o client_app_id.

[
  {
    "_id": "5997529e46224c6e42gb6dd9",
    "group_id": "57879f6cc4b32dbe440bb8c5",
    "domain_id": "5886619e46124e4c42fb5dd8",
    "client_app_id": "myapp-abcde",
    "name": "myapp",
    "location": "US-VA",
    "deployment_model": "GLOBAL",
    "last_used": 1615153544,
    "last_modified": 0,
    "product": "standard",
    "environment": ""
  }
]

Obter um token de acesso à sessão da API de administrador

Toda solicitação ao App Services Admin API deve incluir um token de acesso válido e não expirado emitido pela API do MongoDB Cloud. Inclua esse token no cabeçalho Authorization de cada solicitação usando o esquema de autenticação do portador.

Você precisa de uma chave de API programática do MongoDB Atlas válida para o MongoDB Atlas obter um token.

Depois de ter um par de chaves de API, chame o endpoint de autenticação:

curl --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"username": "<Public API Key>", "apiKey": "<Private API Key>"}' \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login

Se a autenticação for bem-sucedida, o App Services retorna um token de acesso como parte do documento de resposta JSON:

{
  "access_token": "<access_token>",
  "refresh_token": "<refresh_token>",
  "user_id": "<user_id>",
  "device_id": "<device_id>"
}

O access_token representa uma autorização de tempo limitado para interagir com a API Admin. Para autenticar uma solicitação, inclua o token em um Authorization cabeçalho de Token do portador.

Authorization: Bearer <access_token>

Atualizar um token de acesso à sessão da API de administrador

Os tokens de acesso à sessão expiram 30 minutos após serem emitidos. Quando você faz login, a resposta também inclui um refresh_token que pode ser usado para obter um novo token de acesso. Isso é útil porque você só precisa fazer login com as credenciais uma única vez. Depois disso, você pode usar o token de atualização para se autenticar novamente enquanto ele for válido.

Por padrão, os tokens de atualização expiram 60 dias após serem emitidos. Você pode personalizar a expiração do token de atualização para um mínimo de 30 minutos ou um máximo de 5 anos.

Para atualizar sua autenticação e obter um novo access_token, chame o endpoint da sessão de autenticação com seu refresh_token no cabeçalho Authorization :

curl --request POST \
  --header 'Authorization: Bearer <refresh_token>' \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/session

Se o token de atualização for válido, o corpo da resposta incluirá um novo access_token válido pelos próximos 30 minutos:

{
  "access_token": "<access_token>"
}

Esta é a versão 3.0 desta documentação da API. Última atualização em 12 de junho de 2025.

MongoDB Atlas App Services Admin API 3.0