- API >
- Public API Resources >
- Log Collection Jobs >
- Extend a Log Collection Job
Extend a Log Collection Job¶
On this page
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. Each job is created with a specified expiration date. Use this endpoint to extend the expiration date of an existing log collection job.
Note
You cannot extend the duration of log collection jobs which have already expired.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
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 log collection job to extend.
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 For endpoints that return one result, the response body includes:
|
false |
Request Body Parameters¶
Name | Type | Necessity | Description |
---|---|---|---|
expirationDate |
string | Required | Timestamp, in the number of seconds that have elapsed since the UNIX epoch when this job expires. 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. |
Response¶
This endpoint does not return a response body.