MongoDB Rolling Index API
Creates one index to a database deployment in a rolling manner. Rolling indexes build indexes on the applicable nodes sequentially and may reduce the performance impact of an index build if your deployment's average CPU utilization exceeds (N-1)/N-10% where N is the number of CPU threads available to mongod of if the WiredTiger cache fill ratio regularly exceeds 90%. If your deployment does not meet this criteria, use the default index build. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.
MongoDB Rolling Index API is one of 53 APIs that MongoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Rolling Index. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a changelog.
This API exposes 1 operation across 1 path, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 2.0.
Requests are made against a single base URL, https://cloud.mongodb.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
MongoDB Rolling Index API declares
2 security schemes
for authenticating requests.
It uses HTTP digest authentication (DigestAuth).
It supports OAuth 2.0 (ServiceAccounts) using the clientCredentials flow.
By default, every request must be authenticated.
ServiceAccounts— Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview).
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
Creates one index to a database deployment in a rolling manner. Rolling indexes build indexes on the applicable nodes sequentially and may reduce the performance impact of an inde…
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are IndexOptions (17 properties), Collation (9 properties), ApiError (6 properties), DatabaseRollingIndexRequest (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from MongoDB 12
Other APIs MongoDB publishes across the network.
This is an independent, third-party profile of MongoDB Rolling Index API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.