- API >
- API Resources >
- Monitoring and Logs >
- Logs
Logs¶
On this page
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.
Retrieves a compressed (.gz) log file that contains a range of log
messages for a particular host in an Atlas cluster.
Note
This feature is not available for M0 (Free Tier), M2, and M5
clusters. For more information, see Atlas M0 (Free Tier), M2, and M5 Limitations.
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.
Important
You must be an owner of the project that the cluster belongs to in
order to retrieve the log.
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
Syntax¶
Request Path Parameters¶
| Parameter | Required/Optional | Description |
|---|---|---|
GROUP-ID |
Required | Project identifier. |
HOSTNAME |
Required | Name of the host. |
LOG-NAME |
Required | The name of the log file that you want to retrieve:
|
Request Query Parameters¶
| Field | Required/Optional | Description |
|---|---|---|
startDate |
Optional. | Unix timestamp that specifies starting point for the range of log messages to retrieve. Default is 24 hours prior to the current timestamp. |
endDate |
Optional. | Unix timestamp that specifies the end point for the range of log messages to retrieve. Default is current timestamp. |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response Elements¶
This endpoint does not return an HTTP response body.