AtlasUI Documentation

Welcome to AtlasUI’s documentation. AtlasUI is a comprehensive user interface for MongoDB Atlas, providing both a web-based interface and CLI tool for managing MongoDB Atlas resources.

Contents

• Installation
  • Requirements
  • Installation Steps
  • Configuration
  • Getting Atlas API Keys
  • Verification
• Quick Start
  • Web Interface
  • Command-Line Interface
  • API Usage
  • Next Steps
• Features
  • Operation Queue System
  • Cluster Pause/Resume
  • Flex Cluster Support
  • Status-Based Polling
  • Exit Server Modal
  • Database-Themed Favicon
  • Project-Based Filtering
  • IP Access List Management
  • Open in MongoDB Compass
  • Responsive UI
• Service Account Authentication
  • Why Use Service Accounts?
  • How It Works
  • Prerequisites
  • Creating a Service Account
  • Configuration
  • Usage
  • Token Management
  • Security Best Practices
  • Troubleshooting
  • Migration from API Keys
  • Differences from API Keys
  • API Reference
  • Additional Resources
• Security Guidelines
  • Authentication Methods
  • Built-In Security Features
  • Credential Management
  • Network Security
  • Application Security
  • Credential Rotation
  • Monitoring & Auditing
  • Compliance
  • Vulnerability Management
  • Incident Response
  • Reporting Security Issues

Screenshots

Dashboard

Organizations

All Clusters

All Projects

Features

• Web UI: FastAPI-based web interface for MongoDB Atlas management

• CLI Tool: Command-line interface for Atlas operations

• Complete API Coverage: Built from official MongoDB Atlas OpenAPI specifications

• Modern Stack: FastAPI, Typer, Rich, and modern Python tooling

• Operation Queue: Intelligent queuing system for long-running operations with real-time progress tracking

• Status-Based Polling: Accurate cluster status monitoring for reliable deletion operations

• Responsive Design: Mobile-friendly Bootstrap 5 interface with real-time updates

Atlas API Coverage

This UI provides access to all MongoDB Atlas administration APIs including:

• Clusters: Create, configure, and manage MongoDB clusters

• Projects: Manage Atlas projects and organizations

• Backup & Restore: Configure backups and restore operations

• Alerts: Set up and manage alert configurations

• Access Control: Manage users, roles, and API keys

• Monitoring: View metrics and performance data

• Federation: Configure identity providers and SSO

• Network Access: Manage IP access lists and private endpoints

Indices and tables

• Index

• Module Index

• Search Page