Properties
| Name | Type | Description |
|---|---|---|
| _id | string | Unique 24-hexadecimal digit string that identifies the private endpoint. |
| cloudProviderEndpointId | string | Unique string that identifies the private endpoint's network interface. |
| comment | string | Human-readable comment associated with the private endpoint. |
| endpointServiceName | string | Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service. |
| errorMessage | string | Human-readable error message that indicates error condition associated with establishing the private endpoint connection. |
| status | string | Human-readable label that indicates the current operating status of the private endpoint. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/mongodb/main/json-schema/mongodb-serverless-tenant-endpoint-schema.json",
"title": "ServerlessTenantEndpoint",
"x-generated": "2026-10-03",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/mongodb-serverless-private-endpoints-api-openapi.yml#/components/schemas/ServerlessTenantEndpoint",
"oneOf": [
{
"$ref": "#/$defs/ServerlessAWSTenantEndpoint"
},
{
"$ref": "#/$defs/ServerlessAzureTenantEndpoint"
}
],
"properties": {
"_id": {
"description": "Unique 24-hexadecimal digit string that identifies the private endpoint.",
"pattern": "^([a-f0-9]{24})$",
"readOnly": true,
"type": "string"
},
"cloudProviderEndpointId": {
"description": "Unique string that identifies the private endpoint's network interface.",
"readOnly": true,
"type": "string"
},
"comment": {
"description": "Human-readable comment associated with the private endpoint.",
"maxLength": 80,
"readOnly": true,
"type": "string"
},
"endpointServiceName": {
"description": "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.",
"pattern": "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$",
"readOnly": true,
"type": "string"
},
"errorMessage": {
"description": "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.",
"readOnly": true,
"type": "string"
},
"status": {
"description": "Human-readable label that indicates the current operating status of the private endpoint.",
"enum": [
"RESERVATION_REQUESTED",
"RESERVED",
"INITIATING",
"AVAILABLE",
"FAILED",
"DELETING"
],
"readOnly": true,
"type": "string"
}
},
"type": "object",
"$defs": {
"ServerlessAWSTenantEndpoint": {
"description": "View for a serverless AWS tenant endpoint.",
"properties": {
"_id": {
"description": "Unique 24-hexadecimal digit string that identifies the private endpoint.",
"pattern": "^([a-f0-9]{24})$",
"readOnly": true,
"type": "string"
},
"cloudProviderEndpointId": {
"description": "Unique string that identifies the private endpoint's network interface.",
"pattern": "^vpce-[0-9a-f]{17}$",
"readOnly": true,
"type": "string"
},
"comment": {
"description": "Human-readable comment associated with the private endpoint.",
"maxLength": 80,
"readOnly": true,
"type": "string"
},
"endpointServiceName": {
"description": "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.",
"pattern": "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}",
"readOnly": true,
"type": "string"
},
"errorMessage": {
"description": "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.",
"readOnly": true,
"type": "string"
},
"providerName": {
"description": "Human-readable label that identifies the cloud service provider.",
"enum": [
"AWS"
],
"readOnly": true,
"type": "string"
},
"status": {
"description": "Human-readable label that indicates the current operating status of the private endpoint.",
"enum": [
"RESERVATION_REQUESTED",
"RESERVED",
"INITIATING",
"AVAILABLE",
"FAILED",
"DELETING"
],
"readOnly": true,
"type": "string"
}
},
"title": "AWS",
"type": "object"
},
"ServerlessAzureTenantEndpoint": {
"description": "View for a serverless Azure tenant endpoint.",
"properties": {
"_id": {
"description": "Unique 24-hexadecimal digit string that identifies the private endpoint.",
"pattern": "^([a-f0-9]{24})$",
"readOnly": true,
"type": "string"
},
"cloudProviderEndpointId": {
"description": "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.",
"pattern": "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$",
"readOnly": true,
"type": "string"
},
"comment": {
"description": "Human-readable comment associated with the private endpoint.",
"maxLength": 80,
"readOnly": true,
"type": "string"
},
"endpointServiceName": {
"description": "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.",
"pattern": "^pls_[0-9a-f]{24}$",
"readOnly": true,
"type": "string"
},
"errorMessage": {
"description": "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.",
"readOnly": true,
"type": "string"
},
"privateEndpointIpAddress": {
"description": "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.",
"pattern": "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$",
"readOnly": true,
"type": "string"
},
"privateLinkServiceResourceId": {
"description": "Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages. MongoDB Cloud returns null while it creates the endpoint service.",
"readOnly": true,
"type": "string"
},
"providerName": {
"description": "Human-readable label that identifies the cloud service provider.",
"enum": [
"AZURE"
],
"readOnly": true,
"type": "string"
},
"status": {
"description": "Human-readable label that indicates the current operating status of the private endpoint.",
"enum": [
"RESERVATION_REQUESTED",
"RESERVED",
"INITIATING",
"AVAILABLE",
"FAILED",
"DELETING"
],
"readOnly": true,
"type": "string"
}
},
"title": "Azure",
"type": "object"
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/mongodb-serverless-tenant-endpoint"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.