Importante
Cada API de administración de Atlas tiene sus propios recursos y requiere una configuración 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 aprender más, consulta Acceso programático de Atlas.
La API de administración de Atlas sigue los principios del estilo arquitectónico REST para exponer una serie de recursos internos que permiten el acceso programático a las funcionalidades administrativas de Atlas. Para aprender más sobre la API de administración de Atlas, consulta Referencia de la API de Administración de Atlas.
La API de administración de Atlas no proporciona acceso a los datos almacenados en tus clústeres. Para leer o escribir datos en una base de datos, debes autenticarte en tu clúster utilizando las credenciales de un usuario de base de datos con los roles de lectura o escritura adecuados. Puedes utilizar la API de administración de Atlas para crear y gestionar usuarios de base de datos.
Para usar la API de administración de Atlas para gestionar tus clústeres de Atlas, debes usar la autenticación de tus solicitudes de API con uno de los siguientes métodos de autenticación:
Tokens de acceso a la cuenta de servicio(OAuth.) 20
Claves API (Digest access authentication)
Para aprender sobre estos métodos, consulta Métodos de Autenticación de la Atlas Administration API.
Las siguientes secciones describen cómo utilizar cuentas de servicio y claves API para configurar el acceso programático a tus organizaciones y proyectos de Atlas.
Nota
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 comenzar
Antes de configurar el acceso programático, confirme lo siguiente:
Tiene una cuenta de Atlas. Para crear una, consulte Cree una cuenta de Atlas.
Existe una organización de Atlas. Para crear uno, consulte Crear una organización.
Acceso requerido
Para crear una cuenta de servicio o API claves para una organización, debe tener acceso a esa Organization Owner organización.
Para conceder acceso de una cuenta de servicio a un proyecto, debes tener Organization Owner acceso a la organización que posee el proyecto.
Para otorgar acceso a las claves de la API a un proyecto, debe tener acceso a Project Owner para ese proyecto.
Opcional: solicitar una lista de acceso IP
Cuando crea una organización utilizando la Interfaz de Usuario de Atlas, Atlas requiere una lista de acceso IP para la Atlas Administration API. Esto limita las solicitudes de la API solo a aquellas provenientes de las direcciones IP basadas en la ubicación o CIDR que especifique en la lista de acceso IP. Si realiza una solicitud a la Atlas Administration API sin una entrada en la lista de acceso IP, el servidor responde con un código de estado 403.
Si desactiva esta funcionalidad, podrá realizar solicitudes de API desde cualquier dirección en Internet siempre que la lista de acceso IP esté vacía. Una vez que añadas una entrada a la lista de acceso IP, solo las solicitudes originadas desde esa dirección IP pueden realizar solicitudes.
Nota
Las listas de acceso IP se aplican a las usando los tokens de acceso a cuentas de servicio, no a la creación o la revocación de los mismos. Puedes generar un token desde cualquier dirección IP, pero solo puedes usarlo para llamar a la API si tu dirección IP está en la lista de acceso.
Nota
Las listas de acceso IP se aplican solo a las claves de API programáticas y a las cuentas de servicio. No se aplican a otros tipos de acceso a la Atlas Administration API, como la Atlas CLI o el acceso delegado concedido a través de Atlas App Connections. El acceso delegado incluye aplicaciones de terceros emparejadas, aplicaciones de MongoDB como MongoDB Compass y clientes de Model Context Protocol (MCP). Si su organización requiere que todo el tráfico de la Atlas Administration API se origine en direcciones específicas, no habilite el acceso delegado a la aplicación para esa organización. La configuración de acceso delegado para aplicaciones emparejadas y clientes de MCP está desactivada por defecto en las organizaciones existentes.
Para establecer que la organización requiera listas de acceso IP para cada solicitud de la Atlas Administration API después de la creación de la organización, se deben seguir estos pasos:
En Atlas, diríjase a la página Organization Settings.
Si aún no se muestra, selecciona la organización deseada en el menú Organizations de la barra de navegación.
En la barra lateral, haga clic en Organization Settings.
Se muestra la página Configuración de la organización.
Concede acceso programático a una organización
Otorgar acceso programático a un proyecto
Para obtener más información sobre estos dos métodos de autenticación, consulta Métodos de Autenticación de la Atlas Administration API.
Para otorgar acceso a las claves de API a un proyecto, debe tener acceso de Project Access Manager o Project Owner para ese proyecto.
Agregar acceso al proyecto desde un proyecto
Si aún no ha creado una cuenta de servicio o claves API para una organización, puede crearlas para un Proyecto y así concederle acceso a la Atlas Administration API. La cuenta de servicio o las claves API que cree para un Proyecto se añaden automáticamente a la organización matriz con el permiso Organization Member.
Realizar una solicitud de API.
La API de administración de Atlas utiliza uno de los dos métodos de autenticación para autenticar las solicitudes: cuenta de servicio o claves de API. Necesitarás las claves o el secreto que guardaste al configurar tu método de autenticación preferido para completar los siguientes procedimientos.
Todos los endpoints de la Atlas Administration API tienen la siguiente URL base:
https://cloud.mongodb.com/api/atlas/<version>
Importante
MongoDB usa URL HTTPS para aumentar la seguridad. El uso de URL HTTP devolverá un código de estado 301.
Tip
Como alternativa, puede usar cualquier herramienta que admita la especificación OpenAPI v3 para generar ejemplos de código o servidores simulados. Por ejemplo, puede importar la especificación de la API de administración de Atlas en Postman para generar curl comandos.
Advertencia
El uso de una URL HTTP con Postman devolverá un código de estado 301 como se esperaba. Sin embargo, en este escenario, Postman puede reintentar automáticamente la solicitud con HTTPS, pero al mismo tiempo eliminar el encabezado y el cuerpo de la solicitud de reintento. Esto devolverá un código de estado 401 en lugar de 301, lo que dificultará determinar por qué falló la solicitud.
Para utilizar Postman para generar comandos curl:
En la Atlas Administration API documentation de MongoDB, haga clic en Download source en la barra de navegación.
Próximos pasos
Para aprender más sobre la Atlas Administration API, consulta la Referencia de la Atlas Administration API.
Para gestionar el acceso programático a la API de Administración de Atlas, consulte cualquiera de los siguientes procedimientos: