MongoDB Atlas App Services Admin API
3.0

URL base

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

Aviso de fin de vida útil (EOL)

LOS SERVICIOS DE LA APLICACIÓN HAN LLEGADO AL FIN DE SU VIDA ÚTIL (EOL). Atlas Device Sync, los SDK, la API de datos, GraphQL, el alojamiento estático y los puntos finales HTTPS alcanzaron el EOL el de septiembre 30 2025del. Los activadores de la base de datos siguen disponibles.

Esto afecta capacidades adicionales de App Service, incluyendo autenticación y gestión de usuarios, funciones, protocolo de conexión, y permisos de acceso a los datos. Los puntos de acceso de la API relacionados con estas funcionalidades están en desuso.

Para obtener más información, consulte la página de Desuso: https://www.mongodb.com/es/docs/atlas/app-services/deprecation/.

API Overview

La API de administración de App Services permite realizar tareas administrativas mediante programación a través de HTTPS. Esto incluye definir y configurar aspectos como:

App Deployment & Security
APIs & Endpoints
Authentication & User Management
fuente de datos
Device Sync
Environments
Funciones
Registros
Reglas
Schemas
Static Hosting
Activadores
Usage & Billing Metrics
Values & Secrets

La API de administración es para el desarrollo de aplicaciones, configuración y implementación. Para utilizar las funcionalidades que configuras con la API de administración, las aplicaciones cliente se conectan con una API HTTPS específica para tu aplicación.

ID de Proyecto y aplicaciones

Nota: los términos ID del proyecto y ID del grupo son intercambiables.

Atlas App Services Admin API endpoints frequently require you to include two parameters in the URL:

Your Atlas Project ID (also sometimes called a Group ID)
Tus Servicios de aplicación ID de la aplicación

ID del proyecto

You can find your Project ID from the MongoDB Atlas dashboard or with the MongoDB Atlas CLI.

ID de aplicación

Para encontrar un ID de aplicación, realiza una solicitud al punto final "List Apps" de tu proyecto. Necesitarás un access_token para realizar esta solicitud. Para saber cómo obtenerlo,consulta "Obtener un token de acceso a la sesión de la API de administración".

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

Esto devolverá una lista de objetos que describen cada aplicación App Services en el Proyecto/grupo proporcionado. Para solicitudes de la API de administrador, el ID de la aplicación es el valor de ObjectId en el campo _id, no en 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": ""
  }
]

Get an Admin API Session Access Token

Cada solicitud a la API de administración de App Services debe incluir un token de acceso válido y vigente emitido por la API de MongoDB Cloud. Este token se incluye en el encabezado Authorization de cada solicitud mediante el esquema de autenticación de portador.

You need a valid MongoDB Atlas programmatic API key for MongoDB Atlas to get a token.

Once you have an API key pair, call the authentication endpoint:

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

If authentication succeeds, App Services returns an access token as part of the JSON response document:

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

The access_token represents a limited-time authorization to interact with the Admin API. To authenticate a request, include the token in a Bearer token Authorization header.

Authorization: Bearer <access_token>

Actualizar un token de acceso a la sesión de API de administrador

Los tokens de acceso a la sesión caducan 30 minutos después de su emisión. Al iniciar sesión, la respuesta también incluye un refresh_token que puede usar para obtener un nuevo token de acceso. Esto es útil porque solo necesita iniciar sesión con sus credenciales una vez. Después, puede usar el token de actualización para volver a autenticarse mientras sea válido.

De forma predeterminada, los tokens de actualización caducan a los 60 días de su emisión. Puede personalizar su caducidad con un mínimo de 30 minutos o un máximo de 5 años.

To refresh your authentication and get a new access_token, call the auth session endpoint with your refresh_token in the Authorization header:

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

Si el token de actualización es válido, el cuerpo de la respuesta incluye un nuevo access_token que es válido durante los próximos 30 minutos:

{
  "access_token": "<access_token>"
}

Esta es la versión 3.0 de la documentación de la API. Última actualización: 23 de septiembre de 2025.

MongoDB Atlas App Services Admin API 3.0