{ "opencollection": "1.0.0", "info": { "name": "MongoDB Atlas Administration Access Tracking 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": "Access Tracking", "type": "folder" }, "items": [ { "info": { "name": "Return Database Access History for One Cluster by Cluster Name", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/dbAccessHistory/clusters/:clusterName", "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": "authResult", "value": "", "type": "query", "description": "Flag that indicates whether the response returns the successful authentication attempts only." }, { "name": "clusterName", "value": "", "type": "path", "description": "Human-readable label that identifies the cluster." }, { "name": "end", "value": "", "type": "query", "description": "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds." }, { "name": "ipAddress", "value": "", "type": "query", "description": "One Internet Protocol address that attempted to authenticate with the database." }, { "name": "nLogs", "value": "", "type": "query", "description": "Maximum number of lines from the log to return." }, { "name": "start", "value": "", "type": "query", "description": "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds." } ] }, "docs": "Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role, the Project Database Access Admin role, or the Project Cluster Log Viewer role." }, { "info": { "name": "Return Database Access History for One Cluster by Hostname", "type": "http" }, "http": { "method": "GET", "url": "https://cloud.mongodb.com/api/atlas/v2/groups/:groupId/dbAccessHistory/processes/:hostname", "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": "authResult", "value": "", "type": "query", "description": "Flag that indicates whether the response returns the successful authentication attempts only." }, { "name": "end", "value": "", "type": "query", "description": "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds." }, { "name": "hostname", "value": "", "type": "path", "description": "Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download." }, { "name": "ipAddress", "value": "", "type": "query", "description": "One Internet Protocol address that attempted to authenticate with the database." }, { "name": "nLogs", "value": "", "type": "query", "description": "Maximum number of lines from the log to return." }, { "name": "start", "value": "", "type": "query", "description": "Date and time when MongoDB Cloud begins retrieving database history. If you specify **start**, you must also specify **end**. This parameter uses UNIX epoch time in milliseconds." } ] }, "docs": "Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting Service Account or API Key must have the Project Monitoring Admin role, the Project Database Access Admin role, or the Project Cluster Log Viewer role." } ] } ], "bundled": true }