Navigation

Create a Log Collection Job

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. 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, Cloud Manager starts a background job to download the logs from the specified Cloud Manager deployment. Use this endpoint to create a new log collection job.

Base URL: https://cloud.mongodb.com/api/public/v1.0

Resource

POST /groups/{GROUP-ID}/logCollectionJobs

Request Path Parameters

Name Type Description
GROUP-ID string Unique identifier of the project for which to create a log collection job.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Cloud Manager API resources. These are all optional.

Name Type Description Default
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 envelope=true in the query.

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

status
HTTP response code
envelope
The expected response body
false

Request Body Parameters

Name Type Necessity Description
resourceType string Required

Type of resource from which to collect logs. Must be one of the following values:

  • CLUSTER
  • PROCESS
  • REPLICA_SET
resourceName string Required Name of the resource from which to collect logs.
sizeRequestedPerFileBytes number Required Size for each log file in bytes.
logTypes array Required

Array of strings specifying the types of logs to collect. Each array element must be one of the following values:

  • AUTOMATION_AGENT
  • BACKUP_AGENT
  • MONITORING_AGENT
  • MONGODB
  • FTDC
redacted boolean Optional If set to true, emails, hostnames, IP addresses, and namespaces in API responses involving this job are replaced with random string values.

Response

Name Type Description
id string Unique identifier of the created log collection job.

Example Request

curl --user "{username}:{apiKey}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs"
 --data '
   {
     “resourceType”: “PROCESS”,
     “resourceName”: “my_deployment_1”,
     “redacted”: true,
     “sizeRequestedPerFileBytes”: 10000000,
     “logTypes”: [
         “FTDC”,
         “MONGODB”,
         “AUTOMATION_AGENT”
     ]
   }'

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 201 Created
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}

Response Body

{ "id": "5c81086e014b76a3d85e1113" }