Domain Audit Settings

Resource Description
GET /api/domainaudit/events All audit events settings
GET /api/domainaudit/settings Returns audit off-load events settings
POST /api/domainaudit/log/reset Logs roll-over and empty audit.log file
PUT /api/domainaudit/events Updates audit events settings
PUT /api/domainaudit/events/refresh Refreshes audit events settings from server
PUT /api/domainaudit/settings Updates audit off-load events settings

Note that the API can be called on each API Server instance using the Routing API

The Domain Audit API allows you to see audit events and audit off-load configuration settings for the NodeManager and API Server Instances.
Each message consist is returned/set as a JSON string for audit events in the following format:

{
    "categories": [
        {
            "categoryName": "string",
            "events": [
                {
                    "id": "integer",
                    "desc": "string",
                    "enabled": "boolean"
                }
            ]
        }
    ]
}

"categories" is the main object containing an array of category objects.

Each category object consists of the following fields:

categoryName

The identifier of the events category.

events

It contains an array of event objects for the category.

Each event object consists of the following fields:

id

The identifier of the Domain Audit event

description

The description of the Domain Audit event

enabled

Whether the auditing for this event is enabled or not.

For audit off-load settings, each message consist is returned/set as a JSON string in the following format:

{
    "enabled" : false,
    "url": "",
    "username" : "",
    "password" : "",
    "trustedPem" : ""
}

enabled

Indicates whether the audit off-load feature is enabled or not.

url

Identifies the destination URL for off-loading.

username

The user's name for the destination server in URL, if needed.

password

Contains the user's password for the configured user's name.

trustedPem

The SSL certificate in PEM format for the destination server in URL, if required.