Importante
Cada API de administración de Atlas tiene sus propios recursos y requiere una configuración inicial.
Solo puedes acceder a los servidores de la API de administración de Atlas a través de internet pública. La API de administración de Atlas no está disponible en conexiones que utilizan emparejamiento de red o nodos privados.
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 características administrativas de Atlas. Para aprender más sobre la API de Administración de Atlas, consulta la 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 sus clústeres de Atlas, debe usar la autenticación de sus solicitudes de API con uno de los siguientes métodos de autenticación:
Tokens de acceso de cuenta de servicio (OAuth 2.0)
Claves API (Digest access authentication)
Para aprender sobre estos métodos, consulta Métodos de Autenticación de la API de Administración de Atlas.
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
El Modelo de Responsabilidad Compartida de MongoDB Atlas define los deberes complementarios de MongoDB y sus clientes en el mantenimiento de un entorno de datos seguro y resiliente. Bajo este marco, MongoDB gestiona la seguridad y la integridad operativa de la plataforma subyacente, mientras que los clientes son responsables de la configuración, gestión y políticas de datos de sus implementaciones específicas. Para obtener un desglose detallado de la propiedad en materia de seguridad y excelencia operativa, consulta el Modelo de Responsabilidad Compartida.
Acceso requerido
Para crear una cuenta de servicio o API claves para una organización, debe tener acceso Organization Owner a esa 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 API a un proyecto, debe tener acceso a Project Owner ese proyecto.
Opcional: solicitar una lista de acceso IP
Cuando creas una organización usando la interfaz de usuario de Atlas, Atlas automáticamente habilita una lista de acceso IP para la API de administración de Atlas. Esto limita las solicitudes de API solo a aquellas que provienen de la IP basada en ubicación o de las direcciones CIDR que especifiques en la lista de acceso IP. Si haces una solicitud a la API de Administración de Atlas sin una entrada en la lista de acceso IP, el servidor responde con un código de estado 403.
Si desactivas esta funcionalidad, podrás realizar solicitudes a 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 los tokens de acceso de la cuenta de servicio que se están utilizando, y no a la creación ni a la revocación de estos. Puede generar un token desde cualquier dirección IP, pero solo puede usarlo para llamar a la API si su dirección IP está en la lista de acceso.
Para establecer que la organización requiera listas de acceso IP para cada solicitud de la API de administración de Atlas 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 API de Administración de Atlas.
Para otorgar acceso a las claves API a un proyecto, se debe tener acceso de Project Access Manager o Project Owner para ese proyecto.
Agregar acceso al proyecto desde un proyecto
Si aún no has creado una cuenta de servicio o claves API para una Organización, puedes crearlas para un Proyecto y así concederle acceso a la API de administración de Atlas. La cuenta de servicio o las claves API que creas para un proyecto se añaden automáticamente a la organización matriz con el permiso Organization Member.
Realizar una solicitud a la API
La API de administración de Atlas utiliza uno de los dos métodos de autenticación para autenticar las solicitudes: una cuenta de servicio o claves de API. Necesitará las claves o el secreto que guardó al configurar el método de autenticación preferido para completar los siguientes procedimientos.
Todos los endpoints de la API de administración de Atlas 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, puedes utilizar cualquier herramienta que soporte la especificación OpenAPI v3 para generar muestras de código o servidores simulados. Por ejemplo, puedes importar la especificación de la API de administración de Atlas en Postman para generar comandos curl.
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 documentación de la API de administración de MongoDB Atlas, haz clic en Download source en la barra de navegación.
Próximos pasos
Para aprender más sobre la API de administración de Atlas, consulta la Referencia de la API de Administración de Atlas.
Para gestionar el acceso programático a la API de Administración de Atlas, consulte cualquiera de los siguientes procedimientos: