{
  "opencollection": "1.0.0",
  "info": {
    "name": "MongoDB Atlas Administration Access Tracking Private Endpoint Services API",
    "version": "2.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "https://cloud.mongodb.com/api/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Private Endpoint Services",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create One Private Endpoint Service for One Provider",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/privateEndpoint/endpointService",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates one private endpoint service for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. When you create a private endpoint service, MongoDB Cloud creates a network container in the project for the cloud provider for which you create the private endpoint service if one doesn't already exist. To learn more about private endpoint terminology in MongoDB Cloud, see Private Endpoint Concepts. To use this resource, the requesting "
        },
        {
          "info": {
            "name": "Update One Private Endpoint Service for One Provider",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/privateEndpoint/endpointService/:endpointServiceId",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              },
              {
                "name": "endpointServiceId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the specified private endpoint service for the project. The cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role."
        },
        {
          "info": {
            "name": "Return Regionalized Private Endpoint Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/privateEndpoint/regionalMode",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              }
            ]
          },
          "docs": "Checks whether each region in the specified cloud service provider can create multiple private endpoints per region. The cloud service provider manages the private endpoint for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role."
        },
        {
          "info": {
            "name": "Toggle Regionalized Private Endpoint Status",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/privateEndpoint/regionalMode",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Enables or disables the ability to create multiple private endpoints per region in all cloud service providers in one project. The cloud service provider manages the private endpoints for the project. Connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime. To use this resource, the requesting Service Account or API Key must have the Project Owner ro"
        },
        {
          "info": {
            "name": "Return All Private Endpoint Services for One Provider",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/privateEndpoint/:cloudProvider/endpointService",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              },
              {
                "name": "cloudProvider",
                "value": "",
                "type": "path",
                "description": "Cloud service provider that manages this private endpoint service."
              }
            ]
          },
          "docs": "Returns the name, interfaces, and state of all private endpoint services for the specified cloud service provider. This cloud service provider manages the private endpoint service for the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role."
        },
        {
          "info": {
            "name": "Return One Private Endpoint Service for One Provider",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/privateEndpoint/:cloudProvider/endpointService/:endpointServiceId",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              },
              {
                "name": "cloudProvider",
                "value": "",
                "type": "path",
                "description": "Cloud service provider that manages this private endpoint service."
              },
              {
                "name": "endpointServiceId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return."
              }
            ]
          },
          "docs": "Returns the name, interfaces, and state of the specified private endpoint service from one project. The cloud service provider hosted this private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role."
        },
        {
          "info": {
            "name": "Remove One Private Endpoint Service for One Provider",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/privateEndpoint/:cloudProvider/endpointService/:endpointServiceId",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              },
              {
                "name": "cloudProvider",
                "value": "",
                "type": "path",
                "description": "Cloud service provider that manages this private endpoint service."
              },
              {
                "name": "endpointServiceId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete."
              }
            ]
          },
          "docs": "Removes one private endpoint service from the specified project. This cloud service provider manages the private endpoint service that belongs to the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role."
        },
        {
          "info": {
            "name": "Create One Private Endpoint for One Provider",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/privateEndpoint/:cloudProvider/endpointService/:endpointServiceId/endpoint",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              },
              {
                "name": "cloudProvider",
                "value": "",
                "type": "path",
                "description": "Cloud service provider that manages this private endpoint."
              },
              {
                "name": "endpointServiceId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates one private endpoint for the specified cloud service provider. This cloud service provider manages the private endpoint service, which in turn manages the private endpoints for the project. To use this resource, the requesting Service Account or API Key must have the Project Owner role. To learn more about considerations, limitations, and prerequisites, see the MongoDB documentation for setting up a private endpoint."
        },
        {
          "info": {
            "name": "Return One Private Endpoint for One Provider",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/privateEndpoint/:cloudProvider/endpointService/:endpointServiceId/endpoint/:endpointId",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              },
              {
                "name": "cloudProvider",
                "value": "",
                "type": "path",
                "description": "Cloud service provider that manages this private endpoint."
              },
              {
                "name": "endpointId",
                "value": "",
                "type": "path",
                "description": "Unique string that identifies the private endpoint you want to return. The format of the `endpointId` parameter differs for AWS and Azure. You must URL encode the `endpointId` for Azure private endpoints."
              },
              {
                "name": "endpointServiceId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint."
              }
            ]
          },
          "docs": "Returns the connection state of the specified private endpoint. The private endpoint service manages this private endpoint which belongs to one project hosted from one cloud service provider. To use this resource, the requesting Service Account or API Key must have the Project Read Only role."
        },
        {
          "info": {
            "name": "Remove One Private Endpoint for One Provider",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/privateEndpoint/:cloudProvider/endpointService/:endpointServiceId/endpoint/:endpointId",
            "params": [
              {
                "name": "envelope",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether Application wraps the response in an `envelope` JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body."
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.\n\n**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              },
              {
                "name": "cloudProvider",
                "value": "",
                "type": "path",
                "description": "Cloud service provider that manages this private endpoint."
              },
              {
                "name": "endpointId",
                "value": "",
                "type": "path",
                "description": "Unique string that identifies the private endpoint you want to delete. The format of the `endpointId` parameter differs for AWS and Azure. You must URL encode the `endpointId` for Azure private endpoints."
              },
              {
                "name": "endpointServiceId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint."
              }
            ]
          },
          "docs": "Removes one private endpoint from the specified project and private endpoint service, as managed by the specified cloud service provider. When the last private endpoint is removed from a given private endpoint service, that private endpoint service is also removed. To use this resource, the requesting Service Account or API Key must have the Project Owner role."
        }
      ]
    }
  ],
  "bundled": true
}