Importante
Cada API de administración de Atlas tiene sus propios recursos y requiere una configuración inicial.
Solo se puede 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 network emparejamiento o nodos privados.
Para aprender más, consulta Acceso programático de Atlas.
La API de administración de Atlas sigue los principios de la Estilo arquitectónico REST para exponer una serie de recursos internos que permiten el acceso programático a funcionalidades administrativas en Atlas. Para obtener más información 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 sus clústeres. Para leer o escribir datos en una base de datos, debe autenticarse en su clúster utilizando las credenciales de un usuario de base de datos con los roles apropiados de lectura o escritura. Puedes utilizar la API de Administración de Atlas para crear y gestionar usuarios de bases 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 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 usar cuentas de servicio y claves API para configurar el acceso programático a organizaciones y proyectos de Atlas.
Acceso requerido
Para crear una cuenta de servicio o API keys para una organización, debes contar con Organization Owner acceso a esa organización.
Para otorgarle a una cuenta de servicio acceso a un proyecto, debe tener acceso a la organización propietaria del Organization Owner proyecto.
Para otorgar acceso a claves API a un proyecto, debe tener acceso para ese Project Owner 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 de la dirección IP basada en ubicación o las direcciones CIDR que especifiques en la lista de acceso IP. Si realizas 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 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 específicamente al uso de los tokens de acceso de la cuenta de servicio, no a la la creación ni a la la revocación de los mismos. Puede generar un token desde cualquier dirección IP, pero solo se puede utilizar para llamar a la API si tu 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, ve a Organization Settings página.
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 conceder claves API acceso a un proyecto, debe tener Project Access Manager o Project Owner acceso 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 crees para un proyecto se agregarán automáticamente a la organización matriz con el permiso Organization Member.
Haz una API solicitud
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 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 API de administración de Atlas de MongoDB documentación, haga 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: