Download Logs from a Log Collection Job¶

On this page

Resource
Response
Example Request
Example Response
- Response Header
- Response Body

Note

Groups and projects are synonymous terms. Your {PROJECT-ID} is the same as your project id. For existing groups, your group/project id remains the same. This page uses the more familiar term group when referring to descriptions. The endpoint remains as stated in the document.

When you create a log collection job, Ops Manager starts a background job to download the logs from the specified Ops Manager deployment. Use this endpoint to download a .tar.gz file stream for all logs associated with the specified job.

You can download logs from both successful and failed log collection jobs. If the job failed, all successful components are downloaded. The logs are downloaded to the same directory where the request is executed, and in the same format used when downloading logs through the Ops Manager UI.

Example

copy

hostname/
    automation_agent/
        Automation-agent-verbose.log.2019-01-...
    mongos/
        ...
    myShard_1/
        27017/
            ...
        27018/
...

Note

You cannot download logs from jobs in the EXPIRED or IN_PROGRESS states.

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource¶

GET /groups/{PROJECT-ID}/logCollectionJobs/{JOB-ID}/download

Request Path Parameters¶

Name	Type	Description
`PROJECT-ID`	string	Unique identifier of the project that the log collection job is associated with.
`JOB-ID`	string	Unique identifier of the job for which to download the logs. You can obtain the `JOB-IDs` associated with your project by using the Get All Log Collection Jobs for One Project endpoint.

Request Query Parameters¶

The following query parameters are optional:

Name Type Description Default

pretty boolean Flag indicating whether the response body should be in a prettyprint format. false

envelope

boolean

Flag indicating 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 envelope=true in the query.

For endpoints that return one result, the response body includes:

Name	Description
`status`	HTTP response code
`envelope`	Expected response body

false

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response¶

This endpoint does not have response elements.

Example Request¶

copy

curl --user "{username}:{apiKey}" --digest
  --header "Accept: application/json"
  --header "Content-Type: application/gzip"
  --include
  --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/logCollectionJobs/{JOB-ID}/download?pretty=true"

Example Response¶

Response Header¶

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body¶

This endpoint does not return a response body.

← Get a Single Log Collection Job Create a Log Collection Job →