How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MongoDB Flex Clusters API

Returns, adds, edits, and removes flex clusters.

MongoDB Flex Clusters API is one of 53 APIs that MongoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Flex Clusters. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a changelog.

This API exposes 6 operations across 3 paths, and defines 37 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.

6 operations 3 paths 37 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://cloud.mongodb.com/api/atlas/v2
Authentication
HTTP Digest, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

MongoDB Flex Clusters 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 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Flex Clusters 6

Returns, adds, edits, and removes flex clusters.

GET
/api/atlas/v2/groups/{groupId}/flexClusters
Return All Flex Clusters from One Project
listGroupFlexClusters 6 params → 200401403404409429500
POST
/api/atlas/v2/groups/{groupId}/flexClusters
Create One Flex Cluster in One Project
createGroupFlexCluster 3 params body → 201400401402403404409429
DELETE
/api/atlas/v2/groups/{groupId}/flexClusters/{name}
Remove One Flex Cluster from One Project
deleteGroupFlexCluster 4 params → 204400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/flexClusters/{name}
Return One Flex Cluster from One Project
getGroupFlexCluster 4 params → 200400401403404409429500
PATCH
/api/atlas/v2/groups/{groupId}/flexClusters/{name}
Update One Flex Cluster in One Project
updateGroupFlexCluster 4 params body → 200400401402403404409429
POST
/api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade
Upgrade One Flex Cluster
tenantGroupFlexClusterUpgrade 3 params body → 200400401402403404409429

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are AtlasTenantClusterUpgradeRequest20240805 (36 properties), FlexClusterDescription20241113 (14 properties), ClusterConnectionStrings (7 properties), ApiError (6 properties). Each schema is shown below with its type and property counts.

FlexConnectionStrings20241113
object
Collection of Uniform Resource Locators that point to the MongoDB database.
2 properties
ClusterDescriptionConnectionStringsPrivateEndpointEndpoint
object
Details of a private endpoint deployed for this cluster.
3 properties
AWSRegionConfig20240805
object
Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.
AWSHardwareSpec20240805
object
Hardware specifications for nodes deployed in the region.
5 properties
PaginatedFlexClusters20241113
object
3 properties 1 required
FlexProviderSettings20241113
object
Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
4 properties
AzureRegionConfig20240805
object
Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.
TenantRegionConfig20240805
object
Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.
ApiError
object
6 properties 2 required
Link
object
2 properties
DedicatedHardwareSpec20240805
object
The current hardware specifications for read only nodes in the region.
2 properties
FieldViolation
object
2 properties 2 required
ClusterConnectionStrings
object
Collection of Uniform Resource Locators that point to the MongoDB database.
7 properties
ResourceTag
object
Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, environment : production.
2 properties 2 required
ReplicationSpec20240805
object
Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.
4 properties
BaseCloudProviderInstanceSize
object
Instance size boundary to which your cluster can automatically scale.
ApiAtlasClusterAdvancedConfigurationView
object
Group of settings that configures a subset of the advanced configuration details.
4 properties
AdvancedComputeAutoScaling
object
Options that determine how this cluster handles CPU scaling.
4 properties
DiskGBAutoScaling
object
Setting that enables disk auto-scaling.
1 property
GCPHardwareSpec20240805
object
3 properties
ClusterDescriptionConnectionStringsPrivateEndpoint
object
Private endpoint-aware connection string that you can use to connect to this cluster through a private endpoint.
5 properties
TenantHardwareSpec20240805
object
3 properties
BiConnector
object
Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.
2 properties
HardwareSpec20240805
object
Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify…
1 property
FlexClusterDescriptionUpdate20241113
object
Settings that you can specify when you update a flex cluster.
3 properties
EmployeeAccessGrantView
object
MongoDB employee granted access level and expiration for a cluster.
3 properties 2 required
GCPRegionConfig20240805
object
Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.
AzureHardwareSpec20240805
object
4 properties
AtlasTenantClusterUpgradeRequest20240805
object
Request containing target state of tenant cluster to be upgraded.
36 properties 1 required
ComponentLabel
object
Human-readable labels applied to this MongoDB Cloud component.
2 properties
BadRequestDetail
object
Bad request detail.
1 property
FlexProviderSettingsCreate20241113
object
Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
4 properties 2 required
FlexClusterDescription20241113
object
Group of settings that configure a MongoDB Flex cluster.
14 properties 1 required
CloudRegionConfig20240805
object
Cloud service provider on which MongoDB Cloud provisions the hosts.
4 properties
AdvancedAutoScalingSettings
object
Options that determine how this cluster handles resource scaling.
2 properties
FlexBackupSettings20241113
object
Flex backup configuration.
1 property
FlexClusterDescriptionCreate20241113
object
Settings that you can specify when you create a flex cluster.
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-flex-clusters-api-openapi.yml Raw ↑

Other APIs MongoDB publishes across the network.

MongoDB Atlas Data API
MongoDB Atlas App Services Admin API
MongoDB Access Tracking API
MongoDB Activity Feed API
MongoDB Alert Configurations API
MongoDB Alerts API
MongoDB Atlas Search API
MongoDB Auditing API
MongoDB AWS Clusters DNS API
MongoDB Cloud Backups API
MongoDB Cloud Migration Service API
MongoDB Cloud Provider Access API
Where this information came from

This is an independent, third-party profile of MongoDB Flex Clusters 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.