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 Private Endpoints API

Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.

MongoDB Serverless Private Endpoints 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 Private Endpoints. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a changelog.

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

5 operations 2 paths 8 schemas 1 DELETE2 GET1 PATCH1 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 Serverless Private Endpoints 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 5

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

Serverless Private Endpoints 5

Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.

GET
/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpointdeprecated
Return All Private Endpoints for One Serverless Instance
listGroupPrivateEndpointServerlessInstanceEndpoint 3 params → 200400401403404429500
POST
/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpointdeprecated
Create One Private Endpoint for One Serverless Instance
createGroupPrivateEndpointServerlessInstanceEndpoint 3 params body → 201400401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}deprecated
Remove One Private Endpoint for One Serverless Instance
deleteGroupPrivateEndpointServerlessInstanceEndpoint 4 params → 204400401403404429500
GET
/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}deprecated
Return One Private Endpoint for One Serverless Instance
getGroupPrivateEndpointServerlessInstanceEndpoint 4 params → 200400401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/privateEndpoint/serverless/instance/{instanceName}/endpoint/{endpointId}deprecated
Update One Private Endpoint for One Serverless Instance
updateGroupPrivateEndpointServerlessInstanceEndpoint 4 params body → 200400401403404429500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ServerlessAzureTenantEndpoint (9 properties), ServerlessAWSTenantEndpoint (7 properties), ApiError (6 properties), ServerlessTenantEndpoint (6 properties). Each schema is shown below with its type and property counts.

ApiError
object
6 properties 2 required
ServerlessAzureTenantEndpoint
object
View for a serverless Azure tenant endpoint.
9 properties
FieldViolation
object
2 properties 2 required
ServerlessAWSTenantEndpoint
object
View for a serverless AWS tenant endpoint.
7 properties
ServerlessTenantEndpoint
object
6 properties
ServerlessTenantEndpointUpdate
object
Update view for a serverless tenant endpoint.
2 properties 1 required
ServerlessTenantCreateRequest
object
1 property
BadRequestDetail
object
Bad request detail.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-serverless-private-endpoints-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 Private Endpoints 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.