/ /

Resources

Server Log Collection Jobs

Server Log Collection Jobs

Extend an Ops Manager Server Log Collection Job Expiration

Ops Manager sets the default expiration of every job to 7 days from the job creation date. Use this endpoint to extend the expiration of an existing job. The new expiration date must be no more than 28 days after the original creation date. You cannot extend a job that has already expired.

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

Resource

PATCH /admin/omLogCollectionJobs/{JOB-ID}

Required Roles

Requires that the API Key calling this endpoint have the Global Owner role.

Request Parameters

Request Path Parameters

Name	Type	Necessity	Description
`JOB-ID`	string	Required	Unique 24-hexadecimal digit string that identifies the Ops Manager server log collection job. To find a job ID, call Get All Ops Manager Server Log Collection Jobs.

Request Query Parameters

The following query parameters are optional:

Name

Type

Necessity

Description

Default

pretty

boolean

Optional

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

false

envelope

boolean

Optional

Flag that 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:

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

false

Request Body Parameters

Name	Type	Necessity	Description
`expirationDate`	string	Required	New expiration timestamp, in ISO 8601 UTC format. The timestamp must be no more than 28 days after the job creation date and no earlier than the time of the request.

Response

This endpoint does not return a response body.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/omLogCollectionJobs/{JOB-ID}?pretty=true" \
     --data '{ "expirationDate": "2026-04-27T10:00:00Z" }'

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.

Back

Download Logs

Retry