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 Private Endpoint Services API

Returns, adds, edits, and removes private endpoint services.

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

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

This API exposes 10 operations across 7 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.

10 operations 7 paths 13 schemas 2 DELETE4 GET2 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 Private Endpoint Services 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 10

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

Private Endpoint Services 10

Returns, adds, edits, and removes private endpoint services.

POST
/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService
Create One Private Endpoint Service for One Provider
createGroupPrivateEndpointEndpointService 3 params body → 200400401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService/{endpointServiceId}
Update One Private Endpoint Service for One Provider
updateGroupPrivateEndpointEndpointService 4 params body → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode
Return Regionalized Private Endpoint Status
getGroupPrivateEndpointRegionalMode 3 params → 200401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/privateEndpoint/regionalMode
Toggle Regionalized Private Endpoint Status
toggleGroupPrivateEndpointRegionalMode 3 params body → 200401403404409429500
GET
/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService
Return All Private Endpoint Services for One Provider
listGroupPrivateEndpointEndpointService 4 params → 200400401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}
Remove One Private Endpoint Service for One Provider
deleteGroupPrivateEndpointEndpointService 5 params → 204400401403404429500
GET
/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}
Return One Private Endpoint Service for One Provider
getGroupPrivateEndpointEndpointService 5 params → 200400401403404429500
POST
/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint
Create One Private Endpoint for One Provider
createGroupPrivateEndpointEndpointServiceEndpoint 5 params body → 200400401402403404409429
DELETE
/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}
Remove One Private Endpoint for One Provider
deleteGroupPrivateEndpointEndpointServiceEndpoint 6 params → 204400401403404429500
GET
/api/atlas/v2/groups/{groupId}/privateEndpoint/{cloudProvider}/endpointService/{endpointServiceId}/endpoint/{endpointId}
Return One Private Endpoint for One Provider
getGroupPrivateEndpointEndpointServiceEndpoint 6 params → 200400401403404429500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ApiError (6 properties), EndpointService (5 properties), CloudProviderEndpointServiceRequest (4 properties), PrivateLinkEndpoint (3 properties). Each schema is shown below with its type and property counts.

CloudProviderEndpointServiceRequest
object
4 properties 2 required
CreateEndpointRequest
object
ApiAtlasModifyEndpointServiceRequestView
object
2 properties 1 required
ApiError
object
6 properties 2 required
CreateAWSEndpointRequest
object
Group of Private Endpoint settings.
1 required
FieldViolation
object
2 properties 2 required
CreateAzureEndpointRequest
object
Group of Private Endpoint settings.
2 required
EndpointService
object
5 properties 1 required
PrivateLinkEndpoint
object
3 properties 1 required
ProjectSettingItemView
object
1 property 1 required
CreateGCPEndpointGroupRequest
object
Group of Private Endpoint settings.
2 required
CreateGCPForwardingRuleRequest
object
2 properties
BadRequestDetail
object
Bad request detail.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-private-endpoint-services-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 Private Endpoint Services 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.