log‑audit Audit

Prev Next

Collects the agent log file from host endpoints.

This audit cannot be imported into a data acquisition script. See Audits That Cannot Be Imported on page 1.

The following error indicates that the log was actively being written to at the time of the request and was busy.

1729, MX_API_SQLITE_DATABASE_BUSY, "SQL database busy".

If this error occurs, submit the request again.

Supported Platforms

Windows, macOS, and Linux

Input Parameters

The following input parameters are available for this audit.

start-time Parameter

Details

Values

Description

Platform

Windows, macOS, and Linux

Windows, macOS, and Linux environments

Format

dateTime

Valid values are a timestamp.

Required?

no

This parameter is not required.

Repeatable?

no

This parameter can be specified only once per audit request. It cannot be repeated.

Valid Values

Specify the start time at which the audit should collect the log file.

end-time Parameter

Details

Values

Description

Platform

Windows, macOS, and Linux

Windows, macOS, and Linux environments

Format

dateTime

Valid values are a timestamp.

Required?

no

This parameter is not required.

Repeatable?

no

This parameter can be specified only once per audit request. It cannot be repeated.

Valid Values

Specify the end time at which the audit should collect the log file.

level Parameter

Details

Values

Description

Platform

Windows, macOS, and Linux

Windows, macOS, and Linux environments

Format

String

Valid values are a string of text.

Required?

no

This parameter is not required.

Repeatable?

no

This parameter can be specified only once per audit request. It cannot be repeated.

Valid Values

"DEBUG" "INFO" "NOTICE" "WARN" "ERR" "CRIT" "ALERT" "EMERG"

Specify the minimum log level that should be collected.

message Parameter

Details

Values

Description

Platform

Windows, macOS, and Linux

Windows, macOS, and Linux environments

Format

String

Valid values are a string of text.

Required?

no

This parameter is not required.

Repeatable?

no

This parameter can be specified only once per audit request. It cannot be repeated.

Valid Values

Specify a log message string to match. The audit will only collect log messages that start with this string.

format Parameter

Details

Values

Description

Platform

Windows, macOS, and Linux

Windows, macOS, and Linux environments

Format

String

Valid values are a string of text.

Required?

no

This parameter is not required.

Repeatable?

no

This parameter can be specified only once per audit request. It cannot be repeated.

Valid Values

"standard" "textfile"

Specify how the log file output should be returned by the audit. Specify "standard" (the default) to receive JSON output. Specify "textfile" to receive a text file.