{
  "opencollection": "1.0.0",
  "info": {
    "name": "MongoDB Atlas Administration Access Tracking Network Peering 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": "Network Peering",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Return All Network Peering Containers in One Project for One Cloud Provider",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/containers",
            "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": "includeCount",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response returns the total number of items (`totalCount`) in the response."
              },
              {
                "name": "itemsPerPage",
                "value": "",
                "type": "query",
                "description": "Number of items that the response returns per page."
              },
              {
                "name": "pageNum",
                "value": "",
                "type": "query",
                "description": "Number of the page that displays the current set of the total objects that the response returns."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              },
              {
                "name": "providerName",
                "value": "",
                "type": "query",
                "description": "Cloud service provider that serves the desired network peering containers."
              }
            ]
          },
          "docs": "Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting Service Account or API Key must have the Project Read Only role."
        },
        {
          "info": {
            "name": "Create One Network Peering Container",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/containers",
            "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 new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting Service Account or API Key must have the Project Owner role."
        },
        {
          "info": {
            "name": "Return All Network Peering Containers in One Project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/containers/all",
            "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": "includeCount",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response returns the total number of items (`totalCount`) in the response."
              },
              {
                "name": "itemsPerPage",
                "value": "",
                "type": "query",
                "description": "Number of items that the response returns per page."
              },
              {
                "name": "pageNum",
                "value": "",
                "type": "query",
                "description": "Number of the page that displays the current set of the total objects that the response returns."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              }
            ]
          },
          "docs": "Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role."
        },
        {
          "info": {
            "name": "Return One Network Peering Container",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/containers/:containerId",
            "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": "containerId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container."
              }
            ]
          },
          "docs": "Returns details about one network peering container in one specified project. Network peering containers contain network peering connections. To use this resource, the requesting Service Account or API Key must have the Project Read Only role."
        },
        {
          "info": {
            "name": "Update One Network Peering Container",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/containers/:containerId",
            "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": "containerId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role."
        },
        {
          "info": {
            "name": "Remove One Network Peering Container",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/containers/:containerId",
            "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": "containerId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove."
              }
            ]
          },
          "docs": "Removes one network peering container in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role."
        },
        {
          "info": {
            "name": "Return All Network Peering Connections in One Project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/peers",
            "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": "includeCount",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response returns the total number of items (`totalCount`) in the response."
              },
              {
                "name": "itemsPerPage",
                "value": "",
                "type": "query",
                "description": "Number of items that the response returns per page."
              },
              {
                "name": "pageNum",
                "value": "",
                "type": "query",
                "description": "Number of the page that displays the current set of the total objects that the response returns."
              },
              {
                "name": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              },
              {
                "name": "providerName",
                "value": "",
                "type": "query",
                "description": "Cloud service provider to use for this VPC peering connection."
              }
            ]
          },
          "docs": "Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role."
        },
        {
          "info": {
            "name": "Create One Network Peering Connection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/peers",
            "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 new network peering connection in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Network Access Manager role. To learn more about considerations and prerequisites, see the Network Peering Documentation."
        },
        {
          "info": {
            "name": "Return One Network Peering Connection in One Project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/peers/:peerId",
            "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": "peerId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve."
              }
            ]
          },
          "docs": "Returns details about one specified network peering connection in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role."
        },
        {
          "info": {
            "name": "Update One Network Peering Connection",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/peers/:peerId",
            "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": "peerId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates one specified network peering connection in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Network Access Manager role."
        },
        {
          "info": {
            "name": "Remove One Network Peering Connection",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/peers/:peerId",
            "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": "peerId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete."
              }
            ]
          },
          "docs": "Removes one network peering connection in the specified project. If you remove the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting Service Account or API Key must have the Project Owner role or Project Network Access Manager role."
        },
        {
          "info": {
            "name": "Verify Connect via Peering-Only Mode for One Project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/privateIpMode",
            "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": "Verifies if someone set the specified project to **Connect via Peering Only** mode. To use this resource, the requesting Service Account or API Key must have the Project Read Only role."
        },
        {
          "info": {
            "name": "Disable Connect via Peering-Only Mode for One Project",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/privateIpMode",
            "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": "Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting Service Account or API Key must have the Project Owner role."
        }
      ]
    }
  ],
  "bundled": true
}