Resource URL: /platform/<<version=3>>/audit/settings

    Overview: This resource contains per-Access Zone Audit settings.

     Methods: GET, PUT

********************************************************************************

Method GET: View per-Access Zone Audit settings.

       URL: GET /platform/<<version=3>>/audit/settings

Query arguments:
zone=<string> Access zone which contains audit settings.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "settings": {
          "type": "object", 
          "description": "Per-Access Zone Audit settings", 
          "properties": {
            "syslog_forwarding_enabled": {
              "type": [
                {
                  "type": "boolean", 
                  "description": "Enables forwarding of events to syslog."
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "audit_failure": {
              "type": [
                {
                  "minItems": 0, 
                  "items": {
                    "enum": [
                      "close", 
                      "create", 
                      "delete", 
                      "get_security", 
                      "logoff", 
                      "logon", 
                      "read", 
                      "rename", 
                      "set_security", 
                      "tree_connect", 
                      "write"
                    ], 
                    "type": "string"
                  }, 
                  "type": "array", 
                  "description": "Filter of protocol operations to Audit when they fail.", 
                  "maxItems": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "audit_success": {
              "type": [
                {
                  "minItems": 0, 
                  "items": {
                    "enum": [
                      "close", 
                      "create", 
                      "delete", 
                      "get_security", 
                      "logoff", 
                      "logon", 
                      "read", 
                      "rename", 
                      "set_security", 
                      "tree_connect", 
                      "write"
                    ], 
                    "type": "string"
                  }, 
                  "type": "array", 
                  "description": "Filter of protocol operations to Audit when they succeed.", 
                  "maxItems": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "syslog_audit_events": {
              "type": [
                {
                  "minItems": 0, 
                  "items": {
                    "enum": [
                      "close", 
                      "create", 
                      "delete", 
                      "get_security", 
                      "logoff", 
                      "logon", 
                      "read", 
                      "rename", 
                      "set_security", 
                      "tree_connect", 
                      "write"
                    ], 
                    "type": "string"
                  }, 
                  "type": "array", 
                  "description": "Filter of Audit operations to forward to syslog.", 
                  "maxItems": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }
          }
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify per-Access Zone Audit settings.

       URL: PUT /platform/<<version=3>>/audit/settings

Query arguments:
zone=<string> Access zone which contains audit settings.

PUT request body schema:
{
  "type": "object", 
  "description": "Per-Access Zone Audit settings", 
  "properties": {
    "syslog_forwarding_enabled": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Enables forwarding of events to syslog."
        }
      ]
    }, 
    "audit_failure": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minItems": 0, 
          "items": {
            "enum": [
              "close", 
              "create", 
              "delete", 
              "get_security", 
              "logoff", 
              "logon", 
              "read", 
              "rename", 
              "set_security", 
              "tree_connect", 
              "write"
            ], 
            "type": "string"
          }, 
          "type": "array", 
          "description": "Filter of protocol operations to Audit when they fail.", 
          "maxItems": 4294967295
        }
      ]
    }, 
    "audit_success": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minItems": 0, 
          "items": {
            "enum": [
              "close", 
              "create", 
              "delete", 
              "get_security", 
              "logoff", 
              "logon", 
              "read", 
              "rename", 
              "set_security", 
              "tree_connect", 
              "write"
            ], 
            "type": "string"
          }, 
          "type": "array", 
          "description": "Filter of protocol operations to Audit when they succeed.", 
          "maxItems": 4294967295
        }
      ]
    }, 
    "syslog_audit_events": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minItems": 0, 
          "items": {
            "enum": [
              "close", 
              "create", 
              "delete", 
              "get_security", 
              "logoff", 
              "logon", 
              "read", 
              "rename", 
              "set_security", 
              "tree_connect", 
              "write"
            ], 
            "type": "string"
          }, 
          "type": "array", 
          "description": "Filter of Audit operations to forward to syslog.", 
          "maxItems": 4294967295
        }
      ]
    }
  }
}

There is no JSON response body for this method.
