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 Serverless Instances API

Returns, adds, edits, and removes serverless instances.

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

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

This API exposes 2 operations across 2 paths, and defines 13 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.

2 operations 2 paths 13 schemas 2 GET

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 Serverless Instances 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 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Serverless Instances 2

Returns, adds, edits, and removes serverless instances.

GET
/api/atlas/v2/groups/{groupId}/serverlessdeprecated
Return All Serverless Instances in One Project
listGroupServerlessInstances 6 params → 200401403404409429500
GET
/api/atlas/v2/groups/{groupId}/serverless/{name}deprecated
Return One Serverless Instance from One Project
getGroupServerlessInstance 4 params → 200400401403404409429500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ServerlessInstanceDescription (12 properties), ApiError (6 properties), ServerlessProviderSettings (6 properties), ServerlessConnectionStringsPrivateEndpointList (3 properties). Each schema is shown below with its type and property counts.

PaginatedServerlessInstanceDescriptionView
object
3 properties 1 required
ApiError
object
6 properties 2 required
Link
object
2 properties
FieldViolation
object
2 properties 2 required
BaseCloudProviderInstanceSize
object
Instance size boundary to which your cluster can automatically scale.
ResourceTag
object
Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, environment : production.
2 properties 2 required
ServerlessProviderSettings
object
Group of cloud provider settings that configure the provisioned MongoDB serverless instance.
6 properties 2 required
ServerlessConnectionStringsPrivateEndpointItem
object
Details of a private endpoint deployed for this serverless instance.
3 properties
ServerlessInstanceDescriptionConnectionStrings
object
Collection of Uniform Resource Locators that point to the MongoDB database.
2 properties
ServerlessInstanceDescription
object
Group of settings that configure a MongoDB serverless instance.
12 properties 1 required
ClusterServerlessBackupOptions
object
Group of settings that configure serverless backup.
1 property
ServerlessConnectionStringsPrivateEndpointList
object
Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.
3 properties
BadRequestDetail
object
Bad request detail.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-serverless-instances-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 Serverless Instances 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.