- API >
- Public API Resources >
- Diagnostic Archives >
- Get One Project Diagnostic Archive
Get One Project Diagnostic Archive¶
On this page
MongoDB engineers may request that Ops Manager administrators provide diagnostic archives for one project for debugging and troubleshooting. Project diagnostic archives also contain global system information about Ops Manager.
Required Roles¶
The API Key requires the Global Monitoring Admin
or
Global Owner
role to download a diagnostic archive.
Resource¶
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Request Path Parameters¶
Name | Type | Necessity | Description |
---|---|---|---|
GROUP-ID |
string | Required | Unique identifier of the project that owns the diagnostics archive. |
Request Query Parameters¶
The following query parameters are optional:
Name | Type | Description | Default | ||||
---|---|---|---|---|---|---|---|
pageNum |
integer | Page number (1-index based). | 1 |
||||
itemsPerPage |
integer | Number of items to return per page, up to a maximum of 500. | 100 |
||||
pretty |
boolean | Indicates whether the response body should be in a prettyprint format. | false |
||||
envelope |
boolean | Indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set For endpoints that return one result, response body includes:
For endpoints that return a list of results, the |
None | ||||
limit |
integer | Maximum number of entries for the diagnostic archive. | 1000 | ||||
minutes |
integer | Time range of the diagnostic archive, beginning at the specified number of minutes in the past and ending at the present time. Example To retrieve a diagnostic archive with data for the last 10
minutes, specify |
1440 |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
This endpoint returns a .tar.gz
archive file.