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": "object", 
  "properties": {
    "settings": {
      "type": "object", 
      "description": "Settings for Audit.", 
      "properties": {
        "audited_zones": {
          "type": [
            {
              "items": {
                "type": "string"
              }, 
              "type": "array", 
              "description": "Specifies zones that are audited when the protocol_auditing_enabled property is enabled."
            }, 
            {
              "type": "null"
            }
          ]
        }, 
        "config_syslog_enabled": {
          "type": [
            {
              "type": "boolean", 
              "description": "Specifies whether configuration audit syslog messages are forwarded."
            }, 
            {
              "type": "null"
            }
          ]
        }, 
        "cee_log_time": {
          "type": [
            {
              "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'."
            }, 
            {
              "type": "null"
            }
          ]
        }, 
        "hostname": {
          "type": [
            {
              "type": "string", 
              "description": "Specifies the hostname that is reported in protocol events from this cluster."
            }, 
            {
              "type": "null"
            }
          ]
        }, 
        "cee_server_uris": {
          "type": [
            {
              "items": {
                "type": "string"
              }, 
              "type": "array", 
              "description": "Specifies a list of Common Event Enabler (CEE) server URIs. Protocol audit logs are sent to these URIs for external processing."
            }, 
            {
              "type": "null"
            }
          ]
        }, 
        "syslog_log_time": {
          "type": [
            {
              "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"
            }, 
            {
              "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"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "Specifies zones that are audited when the protocol_auditing_enabled property is enabled."
        }
      ]
    }, 
    "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"
        }, 
        {
          "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'."
        }
      ]
    }, 
    "hostname": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "string", 
          "description": "Specifies the hostname that is reported in protocol events from this cluster."
        }
      ]
    }, 
    "cee_server_uris": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "Specifies a list of Common Event Enabler (CEE) server URIs. Protocol audit logs are sent to these URIs for external processing."
        }
      ]
    }, 
    "syslog_log_time": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "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"
        }
      ]
    }, 
    "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 response body for this method.
