Navigation

Rolling Index

The index resource lets you create a rolling index for a cluster. Rolling indexes are created on one cluster node at a time, reducing system stress.

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

Important

You cannot create a rolling index on an M0 (free tier) or M2/M5 (shared tier) cluster. To upgrade a free or shared tier cluster, see Modify a Cluster.

Endpoints

Method Endpoint Description
POST /api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/index Create a rolling index on the specified cluster.