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

    Overview: This resource contains audit settings.

     Methods: GET, PUT

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

Method GET: View Global Audit settings.

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

There are no query arguments for this method.

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": "Settings for Audit.", 
          "properties": {
            "audited_zones": {
              "type": [
                {
                  "minItems": 0, 
                  "items": {
                    "minLength": 0, 
                    "type": "string", 
                    "maxLength": 255
                  }, 
                  "type": "array", 
                  "description": "Specifies zones that are audited when the protocol_auditing_enabled property is enabled.", 
                  "maxItems": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "config_syslog_enabled": {
              "type": [
                {
                  "type": "boolean", 
                  "description": "Specifies whether configuration audit syslog messages are forwarded."
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "cee_log_time": {
              "type": [
                {
                  "minLength": 0, 
                  "type": "string", 
                  "description": "Specifies that events past a certain date are forwarded by the audit CEE forwarder. Format these events as follows: 'Topic@YYYY-MM-DD HH:MM:SS'.", 
                  "maxLength": 255
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "hostname": {
              "type": [
                {
                  "minLength": 0, 
                  "type": "string", 
                  "description": "Specifies the hostname that is reported in protocol events from this cluster.", 
                  "maxLength": 255
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "cee_server_uris": {
              "type": [
                {
                  "minItems": 0, 
                  "items": {
                    "minLength": 0, 
                    "type": "string", 
                    "maxLength": 2048
                  }, 
                  "type": "array", 
                  "description": "Specifies a list of Common Event Enabler (CEE) server URIs. Protocol audit logs are sent to these URIs for external processing.", 
                  "maxItems": 4294967295
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "syslog_log_time": {
              "type": [
                {
                  "minLength": 0, 
                  "type": "string", 
                  "description": "Specifies that events past a specified date are forwarded by the audit syslog forwarder. Format these events as follows: 'Topic@YYYY-MM-DD HH:MM:SS' format", 
                  "maxLength": 255
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "config_auditing_enabled": {
              "type": [
                {
                  "type": "boolean", 
                  "description": "Specifies whether logging for API configuration changes are enabled."
                }, 
                {
                  "type": "null"
                }
              ]
            }, 
            "protocol_auditing_enabled": {
              "type": [
                {
                  "type": "boolean", 
                  "description": "Specifies if logging for the I/O stream is enabled."
                }, 
                {
                  "type": "null"
                }
              ]
            }
          }
        }
      }
    }
  ]
}

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

Method PUT: Modify Global Audit settings.

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

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "Settings for Audit.", 
  "properties": {
    "audited_zones": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minItems": 0, 
          "items": {
            "minLength": 0, 
            "type": "string", 
            "maxLength": 255
          }, 
          "type": "array", 
          "description": "Specifies zones that are audited when the protocol_auditing_enabled property is enabled.", 
          "maxItems": 4294967295
        }
      ]
    }, 
    "config_syslog_enabled": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Specifies whether configuration audit syslog messages are forwarded."
        }
      ]
    }, 
    "cee_log_time": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies that events past a certain date are forwarded by the audit CEE forwarder. Format these events as follows: 'Topic@YYYY-MM-DD HH:MM:SS'.", 
          "maxLength": 255
        }
      ]
    }, 
    "hostname": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies the hostname that is reported in protocol events from this cluster.", 
          "maxLength": 255
        }
      ]
    }, 
    "cee_server_uris": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minItems": 0, 
          "items": {
            "minLength": 0, 
            "type": "string", 
            "maxLength": 2048
          }, 
          "type": "array", 
          "description": "Specifies a list of Common Event Enabler (CEE) server URIs. Protocol audit logs are sent to these URIs for external processing.", 
          "maxItems": 4294967295
        }
      ]
    }, 
    "syslog_log_time": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 0, 
          "type": "string", 
          "description": "Specifies that events past a specified date are forwarded by the audit syslog forwarder. Format these events as follows: 'Topic@YYYY-MM-DD HH:MM:SS' format", 
          "maxLength": 255
        }
      ]
    }, 
    "config_auditing_enabled": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Specifies whether logging for API configuration changes are enabled."
        }
      ]
    }, 
    "protocol_auditing_enabled": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Specifies if logging for the I/O stream is enabled."
        }
      ]
    }
  }
}

There is no JSON response body for this method.
