|
| 1 | +openapi: 3.0.1 |
| 2 | +paths: |
| 3 | + /api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}: |
| 4 | + get: |
| 5 | + description: 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 API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. |
| 6 | + externalDocs: |
| 7 | + description: Database Access History |
| 8 | + url: https://docs.atlas.mongodb.com/access-tracking/ |
| 9 | + operationId: listAccessLogsByClusterName |
| 10 | + parameters: |
| 11 | + - $ref: '#/components/parameters/envelope' |
| 12 | + - $ref: '#/components/parameters/groupId' |
| 13 | + - $ref: '#/components/parameters/pretty' |
| 14 | + - description: Flag that indicates whether the response returns the successful authentication attempts only. |
| 15 | + in: query |
| 16 | + name: authResult |
| 17 | + schema: |
| 18 | + type: boolean |
| 19 | + - description: Human-readable label that identifies the cluster. |
| 20 | + in: path |
| 21 | + name: clusterName |
| 22 | + required: true |
| 23 | + schema: |
| 24 | + maxLength: 64 |
| 25 | + minLength: 1 |
| 26 | + pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*$ |
| 27 | + type: string |
| 28 | + - 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. |
| 29 | + in: query |
| 30 | + name: end |
| 31 | + schema: |
| 32 | + format: int64 |
| 33 | + type: integer |
| 34 | + - description: One Internet Protocol address that attempted to authenticate with the database. |
| 35 | + in: query |
| 36 | + name: ipAddress |
| 37 | + schema: |
| 38 | + pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$ |
| 39 | + type: string |
| 40 | + - description: Maximum number of lines from the log to return. |
| 41 | + in: query |
| 42 | + name: nLogs |
| 43 | + schema: |
| 44 | + default: 20000 |
| 45 | + format: int32 |
| 46 | + maximum: 20000 |
| 47 | + minimum: 0 |
| 48 | + type: integer |
| 49 | + - 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. |
| 50 | + in: query |
| 51 | + name: start |
| 52 | + schema: |
| 53 | + format: int64 |
| 54 | + type: integer |
| 55 | + responses: |
| 56 | + "200": |
| 57 | + content: |
| 58 | + application/vnd.atlas.2023-01-01+json: |
| 59 | + schema: |
| 60 | + $ref: '#/components/schemas/MongoDBAccessLogsList' |
| 61 | + x-xgen-version: "2023-01-01" |
| 62 | + description: OK |
| 63 | + "400": |
| 64 | + $ref: '#/components/responses/badRequest' |
| 65 | + "401": |
| 66 | + $ref: '#/components/responses/unauthorized' |
| 67 | + "500": |
| 68 | + $ref: '#/components/responses/internalServerError' |
| 69 | + summary: Return Database Access History for One Cluster using Its Cluster Name |
| 70 | + tags: |
| 71 | + - Access Tracking |
| 72 | + x-xgen-owner-team: Intel II |
| 73 | + x-xgen-IPA-exception: |
| 74 | + xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation |
| 75 | + /api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}: |
| 76 | + get: |
| 77 | + description: 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 API Key must have the Project Monitoring Admin role or the Project Database Access Admin role. |
| 78 | + externalDocs: |
| 79 | + description: Database Access History |
| 80 | + url: https://docs.atlas.mongodb.com/access-tracking/ |
| 81 | + operationId: listAccessLogsByHostname |
| 82 | + parameters: |
| 83 | + - $ref: '#/components/parameters/envelope' |
| 84 | + - $ref: '#/components/parameters/groupId' |
| 85 | + - $ref: '#/components/parameters/pretty' |
| 86 | + - description: Flag that indicates whether the response returns the successful authentication attempts only. |
| 87 | + in: query |
| 88 | + name: authResult |
| 89 | + schema: |
| 90 | + type: boolean |
| 91 | + - 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. |
| 92 | + in: query |
| 93 | + name: end |
| 94 | + schema: |
| 95 | + format: int64 |
| 96 | + type: integer |
| 97 | + - description: Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download. |
| 98 | + in: path |
| 99 | + name: hostname |
| 100 | + required: true |
| 101 | + schema: |
| 102 | + type: string |
| 103 | + - description: One Internet Protocol address that attempted to authenticate with the database. |
| 104 | + in: query |
| 105 | + name: ipAddress |
| 106 | + schema: |
| 107 | + pattern: ^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$ |
| 108 | + type: string |
| 109 | + - description: Maximum number of lines from the log to return. |
| 110 | + in: query |
| 111 | + name: nLogs |
| 112 | + schema: |
| 113 | + default: 20000 |
| 114 | + format: int32 |
| 115 | + maximum: 20000 |
| 116 | + minimum: 0 |
| 117 | + type: integer |
| 118 | + - 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. |
| 119 | + in: query |
| 120 | + name: start |
| 121 | + schema: |
| 122 | + format: int64 |
| 123 | + type: integer |
| 124 | + responses: |
| 125 | + "200": |
| 126 | + content: |
| 127 | + application/vnd.atlas.2023-01-01+json: |
| 128 | + schema: |
| 129 | + $ref: '#/components/schemas/MongoDBAccessLogsList' |
| 130 | + x-xgen-version: "2023-01-01" |
| 131 | + description: OK |
| 132 | + "401": |
| 133 | + $ref: '#/components/responses/unauthorized' |
| 134 | + "404": |
| 135 | + $ref: '#/components/responses/notFound' |
| 136 | + "500": |
| 137 | + $ref: '#/components/responses/internalServerError' |
| 138 | + summary: Return Database Access History for One Cluster using Its Hostname |
| 139 | + tags: |
| 140 | + - Access Tracking |
| 141 | + x-xgen-owner-team: Intel II |
| 142 | + x-xgen-IPA-exception: |
| 143 | + xgen-IPA-102-path-alternate-resource-name-path-param: API predates IPA validation |
0 commit comments