Get the System Log Rotate Configuration

On this page

Required Roles

Resource
Request
Path Parameters
Query Parameters
Body Parameters
Response
Example Request
Example Response
Response Header
Response Body

This endpoint returns the current system log rotation configuration.

Required Roles

This resource requires the Project Automation Admin role.

Resource

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

GET /groups/{PROJECT-ID}/automationConfig/systemLogRotateConfig

Request

Path Parameters

Name	Type	Necessity	Description
PROJECT-ID	string	Required	Unique identifier of the project that owns the automation configuration.

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

Body Parameters

This endpoint doesn't use HTTP request body parameters.

Response

Name	Type	Description
sizeThresholdMB	float	Maximum size in MB for an individual log file before rotation.
timeThresholdHrs	int	Maximum time in hours for an individual log file before rotation.
numUncompressed	int	Maximum number of total log files to leave uncompressed, including the current log file. The default is `5`. If number of log files is more than max uncompressed, sort by date, and then keep compressing the oldest file until the restraint is met.
percentOfDiskspace	float	Maximum percentage of total disk space all log files should take up before deletion. The default is `.02`. If log files size is taking up more than max percent of total disk space, sort by date, and then keep deleting the oldest file until the restraint is met.
numTotal	int	Total number of log files. If the number of log files on disk is greater than this number, the oldest files will be deleted. If a number is not specified, defaults to 0 and is determined by other settings.

Example Request

curl --user "{publicApiKey}:{privateApiKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/systemLogRotateConfig?pretty=true" \
     --output systemLogRotateConfig.json

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

The response body only includes fields that are configured in Ops Manager.

{
 "sizeThresholdMB": 5005.5,
 "timeThresholdHrs": 13,
 "numUncompressed": 10,
 "percentOfDiskspace": 0.1,
 "numTotal": 15
}

Back

Update the Audit Log Rotate Config

Update the System Log Rotate Config