Atlas Administration API rolling index endpoint
Parent: Rolling index builds · Published reference · snapshot 2026-10-23 · skill mongodb-cohort-6b0d6e198335
↓ Facts as markdownall context files
Source-anchored research for Atlas Administration API rolling index endpoint. Run status: COMPLETED.
These notes link each claim to its source. Some citations identify archived research reports that are no longer hosted on this site. A published reference means the content is available; it does not certify independent review or accuracy.Read the editorial policy and follow the sources before relying on a claim.
Structure and components
- The request requires db, collection, and keys; keys contains field-to-index-type objects. Optional options and collation configure the index. (medium confidence) [source]
How it works
- MongoDB warns that rolling builds reduce cluster resilience and increase build time, and recommends them only when regular builds do not meet requirements. (low confidence) [source]
- A November 19, 2022 Stack Overflow answer to a question about Prisma points to an Atlas API endpoint as a programmatic trigger for the managed rolling-index procedure. This is historical guidance; it does not show that Prisma's index push invokes the endpoint. (low confidence) [source]
Facts and statements
- The v2 endpoint is POST https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index; groupId identifies the project and clusterName identifies the cluster. (high confidence) (verified as of 2026-10-23) [source]
- The documented success response is HTTP 202 Accepted. A May 7, 2024 user example returned {} with status 202 after omitting options.unique; acceptance alone does not demonstrate build completion. (medium confidence) [source]
- Rolling creation builds on one replica-set member as a standalone at a time, secondaries first, and requires at least one election. (high confidence) [source]
- A May 7, 2024 API user reported options.unique:true producing HTTP 500 UNEXPECTED_ERROR while omitting unique returned 202. A reply quoted documentation stating unique was unsupported for rolling indexes; this is historical evidence, not a current reproduction. (low confidence) [source]
- The current endpoint lists Project Data Access Admin and Project Index Manager under role requirements; Formwise independently lists both for its rolling-index integration action. (medium confidence) (verified as of 2026-10-23) [source]
- Formwise advertises a Create Group Cluster Index Rolling Index action backed by the Atlas Administration API. This establishes its advertised integration, not an independent test of Atlas behavior. (low confidence) (verified as of 2026-10-21) [source]
- COMPASS-10970 records that Atlas Infinite clusters do not support rolling index builds and requires Compass/Data Explorer to hide the option. The issue was resolved August 24, 2026 with fix version 1.49.15. (low confidence) (verified as of 2026-08-24) [source]
- The request requires db, collection, and keys. keys is an array of field-to-index-type objects; the API schema represents index-type values as strings. (high confidence) (verified as of 2026-10-23) [source]
- The documented success status is HTTP 202 Accepted. Acceptance alone does not establish build completion; the response documents no multiKeyPaths metadata. (medium confidence) (verified as of 2026-10-23) [source]
- The API lists Project Data Access Admin and Project Index Manager under role requirements; the CLI description mentions only Project Data Access Admin. (medium confidence) (verified as of 2026-10-23) [source]
- atlas api rollingIndex createRollingIndex wraps this endpoint. Supply --groupId and --clusterName, and pass the request through --file or standard input. (low confidence) (verified as of 2026-10-20) [source]
- The independent mongodb-atlas-admin 0.0.1 Rust wrapper README marks Rolling Index and Create One Rolling Index unchecked. Its endpoint inventory therefore does not establish an implemented client operation. (low confidence) [source]
- A June 8, 2020 Stack Overflow question reports production index-build performance problems and asks whether rolling-build automation is available. A June 9 user comment by D. SM says Atlas apparently offers automated rolling index builds and links MongoDB documentation; this thread does not document an API endpoint implementation or diagnose the reported performance issue. (low confidence) [source]
Children
- No children recorded.