EndpointService

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mongodb/main/json-schema/mongodb-endpoint-service-schema.json",
  "title": "EndpointService",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/mongodb-private-endpoint-services-api-openapi.yml#/components/schemas/EndpointService",
  "properties": {
    "cloudProvider": {
      "description": "Cloud service provider that serves the requested endpoint service.",
      "enum": [
        "AWS",
        "AZURE",
        "GCP"
      ],
      "readOnly": true,
      "type": "string"
    },
    "errorMessage": {
      "description": "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "description": "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.",
      "pattern": "^([a-f0-9]{24})$",
      "readOnly": true,
      "type": "string"
    },
    "regionName": {
      "description": "Cloud provider region that manages this Private Endpoint Service.",
      "readOnly": true,
      "type": "string"
    },
    "status": {
      "description": "State of the Private Endpoint Service connection when MongoDB Cloud received this request.",
      "enum": [
        "INITIATING",
        "AVAILABLE",
        "WAITING_FOR_USER",
        "FAILED",
        "DELETING"
      ],
      "readOnly": true,
      "type": "string"
    }
  },
  "required": [
    "cloudProvider"
  ],
  "type": "object"
}