MongoDBMongoDB Atlas Administration API v2
GET/api/atlas/v2/groups/{groupId}/flexClusters
Read list Group Flex Clusters.
Contract-preserving GET endpoint for list Group Flex Clusters in the MongoDB Atlas Administration API. Resource-specific values are supplied by the caller at runtime.
All 540 MongoDB Atlas administration endpoints from a fixed Apache-2.0 OpenAPI revision. Hub provides documentation and an independent SDK/CLI, but never proxies account, organization, project, network, backup, or operational data; callers connect directly with local credentials.
Request
- operationId
listGroupFlexClusters- Server
https://cloud.mongodb.com- Authentication
- ServiceAccounts, DigestAuth
Request parameters
envelope
queryboolean
envelope value in the Atlas Administration API contract.
groupId
pathstringrequired
group Id value in the Atlas Administration API contract.
32b6e34b3d91647abb20e7b8
includeCount
queryboolean
include Count value in the Atlas Administration API contract.
itemsPerPage
queryinteger
items Per Page value in the Atlas Administration API contract.
pageNum
queryinteger
page Num value in the Atlas Administration API contract.
pretty
queryboolean
pretty value in the Atlas Administration API contract.
Responses
200
PaginatedFlexClusters20241113application/vnd.atlas.2024-11-13+json
Successful supplier response.
Properties: linksresultstotalCount
401
ApiErrorapplication/json
Supplier response with HTTP status 401.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
403
ApiErrorapplication/json
Supplier response with HTTP status 403.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
404
ApiErrorapplication/json
Supplier response with HTTP status 404.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
409
ApiErrorapplication/json
Supplier response with HTTP status 409.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
429
ApiErrorapplication/json
Supplier response with HTTP status 429.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
500
ApiErrorapplication/json
Supplier response with HTTP status 500.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
{
"links": {
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
},
"results": {
"backupSettings": {
"enabled": true
},
"clusterType": "REPLICASET",
"connectionStrings": {},
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"links": {
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
},
"totalCount": 0
}