audit.export

Generate an audit report based on the specified query-filters and query-options for the specified services in the specified export_format.

Supported export_formats are CSV, JSON, and YAML. The endpoint returns a local filesystem path where the resulting audit report is located.

This method is a job.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object
Default:
{ "services": [ "MIDDLEWARE" ], "query-filters": [], "query-options": { "force_sql_filters": false, "limit": 0, "offset": 0, "order_by": [], "select": [] }, "remote_controller": false, "export_format": "JSON" }

Audit export configuration specifying services, filters, and format.

 No Additional Properties

Services

Type: array of enum (of string) Default: ["MIDDLEWARE"]

Array of services to include in the audit query.

 No Additional Items
Each item of this array must be:
Type: enum (of string)
Must be one of:
  • "MIDDLEWARE"
  • "SMB"
  • "SUDO"
  • "SYSTEM"

Query-Filters

Type: array Default: []

List of filters for query results. See API documentation for "Query Methods" for more guidance.

 No Additional Items
Each item of this array must be:
Type: object

Examples:

[
    [
        "name",
        "=",
        "bob"
    ]
]

[
    [
        "OR",
        [
            [
                [
                    "name",
                    "=",
                    "bob"
                ]
            ],
            [
                [
                    "name",
                    "=",
                    "larry"
                ]
            ]
        ]
    ]
]

AuditExportQueryOptions

Type: object
Default:
{ "order_by": [], "select": [], "offset": 0, "limit": 0, "force_sql_filters": false }

No Additional Properties

Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place any null values at the head of the results list), nulls_last: (place any null values at the tail of the results list).

No Additional Items
Each item of this array must be:
Type: string

Example:

[
    "size",
    "-devname",
    "nulls_first:-expiretime"
]

Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character . may be used to explicitly select only subkeys of the query result.

No Additional Items
Each item of this array must be:

Type: string
Type: array
No Additional Items
Each item of this array must be:
Type: object

Example:

[
    "username",
    "Authentication.status"
]

Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the limit query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified query-filters to return. When combined wtih the offset query-option it may be used to implement pagination of large results arrays.

WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

Force Sql Filters

Type: boolean Default: false

Force use of SQL for result filtering to reduce response time. May not work for all methods.

Remote Controller

Type: boolean Default: false

HA systems may direct the query to the 'remote' controller by including 'remote_controller=True'. The default is the 'current' controller.

Export Format

Type: enum (of string) Default: "JSON"

Format for exporting audit data.

Must be one of:
  • "CSV"
  • "JSON"
  • "YAML"

Result

Type: string

Path to the exported audit data file.


Required roles: SYSTEM_AUDIT_READ