Extend a Log Collection Job


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, Ops Manager starts a background job to download the logs from the specified Ops Manager deployment. Each job is created with a specified expiration date. Use this endpoint to extend the expiration date of an existing log collection job.


You cannot extend the duration of log collection jobs which have already expired.

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


PATCH /groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}

Request Path Parameters

Name Type Description
GROUP-ID string Unique identifier of the project that the log collection job is associated with.
JOB-ID string Unique identifier of the log collection job to extend. You can obtain the JOB-IDs associated with your group by using the Get All Log Collection Jobs for a Group endpoint.

Request Query Parameters

The following query parameters are 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:

HTTP response code
The expected response body

Request Body Parameters

Name Type Necessity Description
expirationDate date Required ISO 8601-formatted date signifying the new expiration date for this job. This can be up to 6 months from the time the job was created. You cannot specify a date which precedes the time the request is made.


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://{OPSMANAGER-HOST}:{PORT}/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}" \
 -- data ' { "expirationDate": "2019-04-06T12:02:54Z" } '

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}

Response Body

This endpoint does not return a response body.