{
  "opencollection": "1.0.0",
  "info": {
    "name": "MongoDB Atlas Administration Access Tracking Online Archive 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": "Online Archive",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Return All Online Archives for One Cluster",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/clusters/:clusterName/onlineArchives",
            "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": "clusterName",
                "value": "",
                "type": "path",
                "description": "Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives."
              }
            ]
          },
          "docs": "Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role."
        },
        {
          "info": {
            "name": "Create One Online Archive",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/clusters/:clusterName/onlineArchives",
            "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": "clusterName",
                "value": "",
                "type": "path",
                "description": "Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role."
        },
        {
          "info": {
            "name": "Download Online Archive Query Logs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/clusters/:clusterName/onlineArchives/queryLogs.gz",
            "params": [
              {
                "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": "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": "startDate",
                "value": "",
                "type": "query",
                "description": "Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time)."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time)."
              },
              {
                "name": "clusterName",
                "value": "",
                "type": "path",
                "description": "Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive."
              },
              {
                "name": "archiveOnly",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster."
              }
            ]
          },
          "docs": "Downloads query logs for the specified online archive. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: `Accept: application/vnd.atlas.YYYY-MM-DD+gzip`."
        },
        {
          "info": {
            "name": "Return One Online Archive",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/clusters/:clusterName/onlineArchives/:archiveId",
            "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": "archiveId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the online archive to return."
              },
              {
                "name": "clusterName",
                "value": "",
                "type": "path",
                "description": "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive."
              }
            ]
          },
          "docs": "Returns one online archive for one cluster. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Read Only role."
        },
        {
          "info": {
            "name": "Update One Online Archive",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/clusters/:clusterName/onlineArchives/:archiveId",
            "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": "archiveId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the online archive to update."
              },
              {
                "name": "clusterName",
                "value": "",
                "type": "path",
                "description": "Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates, pauses, or resumes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role."
        },
        {
          "info": {
            "name": "Remove One Online Archive",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/clusters/:clusterName/onlineArchives/:archiveId",
            "params": [
              {
                "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": "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": "pretty",
                "value": "",
                "type": "query",
                "description": "Flag that indicates whether the response body should be in the prettyprint format."
              },
              {
                "name": "archiveId",
                "value": "",
                "type": "path",
                "description": "Unique 24-hexadecimal digit string that identifies the online archive to delete."
              },
              {
                "name": "clusterName",
                "value": "",
                "type": "path",
                "description": "Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive."
              }
            ]
          },
          "docs": "Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting Service Account or API Key must have the Project Data Access Admin role."
        }
      ]
    }
  ],
  "bundled": true
}