canonical: https://jentic.com/apis/mongodb.com/mongodb

# MongoDB Atlas Administration API

The MongoDB Atlas Administration API is the control plane for the Atlas managed database service. With 468 endpoints, it covers cluster lifecycle, backups, Atlas Search, Data Federation, Online Archive, organisation and project management, alerts, billing, custom database roles, federated authentication, network access, and observability. Authentication is HTTP Digest with API public/private keys or OAuth 2.0 service accounts. Operations span the full cloud database stack so platform teams can build their own internal Atlas portals.

## For AI agents

Provision and manage MongoDB Atlas clusters, backups, Atlas Search indexes, network access, and federated identity at the organisation and project level.

## Scope

Does not run database queries or execute aggregations against your data - use the Atlas Administration API for control-plane management of clusters, backups, search, and access only.

## Capabilities

- Provision, scale, and tear down MongoDB Atlas clusters across AWS, Azure, and GCP regions
- Configure and trigger Cloud Backups, restore snapshots, and run cluster outage simulations
- Create and manage Atlas Search indexes for full-text and vector search workloads
- Define custom database roles and per-project access policies for fine-grained authorisation
- Manage federated identity, organisation configurations, and SSO role mappings via /federationSettings endpoints
- Create alert configurations on resource metrics and inspect activity feeds for audit and SOC use cases
- Administer Data Federation, Online Archive, and access tracking across an Atlas project portfolio

## Use cases

### Self-Service Cluster Provisioning

Platform engineering teams expose Atlas to product squads through an internal portal that calls the Atlas Administration API. Squads request a cluster size, region, and database tier, and the platform creates the cluster, configures backups, sets up alerts, and binds an existing custom role. The 468-endpoint surface covers every Atlas object the portal needs to expose.

Example prompt: Create a new M30 Atlas cluster called orders-staging in eu-west-1 within project proj_42 and confirm the cluster reaches IDLE state.

### Backup and Disaster Recovery Drills

Risk and SRE teams use Cloud Backups to rehearse restore procedures and run outage simulations against non-production clusters. The API can trigger a snapshot, list available restore points, restore into a new cluster, and run a Cluster Outage Simulation, producing an evidence trail through the activity feed.

Example prompt: List the latest snapshot for cluster payments-prod and restore it into a new cluster payments-restored-test.

### Federated Access Management

Enterprises map Atlas access to an external identity provider through Federation Settings. Admins can link organisation configurations to a federation, manage role mappings between IdP groups and Atlas roles, and remove organisations from a federation when an entity is divested. This keeps Atlas access in sync with corporate directory groups.

Example prompt: List role mappings on the engineering organisation under federationSettings_id fed_777 and add a new mapping that grants project read-only access.

### Cost Visibility and Cluster Hygiene

FinOps teams pull cluster inventories, alert configurations, and billing-adjacent data through the Administration API to find oversized or unused clusters. Combined with the activity feed, this produces a recurring report that flags clusters which can be downsized, paused, or terminated before the next bill.

Example prompt: List all clusters across every project, sort by tier, and flag any M40+ cluster with no incoming connections in the last 24 hours.

### AI Agent Database Operations

A platform agent uses Jentic to discover Atlas operations across clusters, backups, alerts, and access management, then executes them with vault-stored OAuth service account credentials. With 468 endpoints in scope, the agent can answer 'which clusters are over-provisioned' or 'create a search index on this collection' without bespoke integration code.

Example prompt: Search Jentic for 'list all Atlas clusters', load the schema for GET /api/atlas/v2/clusters, and return the cluster names sorted by tier.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /api/atlas/v2/clusters | List clusters across all projects |
| GET | /api/atlas/v2 | Return the Atlas application status |
| GET | /api/atlas/v2/eventTypes | List subscribable event types |
| GET | /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs | List connected organisations in a federation |
| PATCH | /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId} | Update a connected organisation configuration |
| GET | /api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}/roleMappings | List role mappings for an organisation |
| GET | /api/atlas/v2/alertConfigs/matchers/fieldNames | List alert configuration matcher field names |

## Key resources

- **Clusters** — Provision, scale, pause, and terminate Atlas clusters
- **Cloud Backups** — Snapshot policies, on-demand snapshots, and restores
- **Atlas Search** — Create and manage full-text and vector search indexes
- **Alert Configurations and Alerts** — Define metric and event-based alerts and list firing alerts
- **Federation Settings** — Federated identity, connected organisations, and role mappings
- **Custom Database Roles** — Granular database-level role and privilege management
- **Activity Feed and Auditing** — Immutable event log for compliance and forensics
- **Data Federation and Online Archive** — Query across S3 and archive cold collections

## Why Jentic

- **Setup:** Wiring the MongoDB Atlas Administration API by hand means implementing Digest signing or the OAuth 2.0 service-account flow and coding calls across a very large control-plane surface yourself. Through Jentic you install once, import the Atlas Administration API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Atlas puts the org and federation id in the URL path (/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}), so a rule can pin your agent to one org config for reads. You choose the operations it may call, so a write like patching a connected org config is not included unless you add it.
- **Credential handling:** Your Atlas Digest key or service-account credentials are stored once, encrypted, by your own Jentic One instance, and Jentic signs each request or attaches a refreshed token at execution time. The secrets never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create an Atlas cluster' or 'list role mappings', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the Atlas docs.

## Related APIs

- **PlanetScale API** — Serverless MySQL platform with branch-based schema management
- **CockroachDB Cloud API** — Distributed SQL database with strong consistency across regions
- **Supabase Management API** — Postgres-based backend platform with auth and realtime built in
- **DigitalOcean API** — Run application VMs and Kubernetes alongside Atlas-hosted databases

## FAQ

### What authentication does the MongoDB Atlas Administration API use?

Two options: HTTP Digest using public/private API keys, or OAuth 2.0 service accounts. OAuth service accounts are recommended for newer integrations. Through Jentic both credential types are stored encrypted in the vault and applied at execution time.

### Can I provision a new Atlas cluster with this API?

Yes. Use POST /api/atlas/v2/groups/{groupId}/clusters to create a cluster with a chosen tier, region, and provider. The cluster is asynchronous; poll the cluster endpoint or watch the activity feed until the state becomes IDLE before connecting applications.

### What are the rate limits for the Atlas Administration API?

Atlas applies request quotas per organisation that are not exposed in the spec. Treat HTTP 429 as a back-off signal and retry with exponential delay; long-running operations like cluster creation are eventually consistent and should be polled rather than spammed.

### How do I list clusters across every project through Jentic?

Search Jentic for 'list all Atlas clusters', load the schema for GET /api/atlas/v2/clusters, and execute it. Jentic injects the Digest or OAuth credential and returns a paginated list spanning every project the credential can access.

### Does the API expose Atlas Search and vector search?

Yes. The Atlas Search resource provides endpoints to create, list, and update search indexes, including indexes that back vector search workloads. Define the index type and analyzer in the request body and Atlas applies it to the named collection.

### Can I manage federated identity and SSO mappings?

Yes. The /api/atlas/v2/federationSettings/{federationSettingsId} family of endpoints lets you list and remove connected organisations and manage role mappings between identity provider groups and Atlas roles. This keeps SSO access aligned with corporate directory changes.

### How do I run a backup and restore through the API?

Use the Cloud Backups endpoints under a project to take an on-demand snapshot, list snapshots, and create a restore job into a new or existing cluster. Pair restores with the Cluster Outage Simulation endpoint to rehearse recovery without affecting production.

### Can I limit what my agent is allowed to do with the MongoDB Atlas Administration API?

Yes. Because you run Jentic One yourself, your own rules decide which Atlas operations and credentials the agent may use. Atlas puts the org and federation id in the URL path, such as /federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}, so a rule can pin the agent to one org config for read-only calls like listing connected organisations or role mappings. You choose the operations it may call, so a write such as PATCH on a connected org config is excluded unless you explicitly add it.