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

    Overview: Settings

     Methods: GET, PUT

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

Method GET: Retrieve the settings.

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

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"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "settings": {
          "type": "object", 
          "description": "Settings for CELOG system", 
          "properties": {
            "heartbeat_interval": {
              "type": "string", 
              "description": "Interval between heartbeat events. \"daily\", \"weekly\", or \"monthly\"."
            }, 
            "storage_limit": {
              "type": "integer", 
              "description": "Storage limit in megabytes per terabyte of available storage"
            }, 
            "retention_days": {
              "type": "integer", 
              "description": "Retention period in days"
            }, 
            "maintenance": {
              "type": [
                {
                  "type": "object", 
                  "description": "Specifies start and duration of maintenance period during which no alerts will be sent for new eventgroups.", 
                  "properties": {
                    "duration": {
                      "type": "integer", 
                      "description": "Duration of maintenance period in seconds."
                    }, 
                    "start": {
                      "type": "integer", 
                      "description": "Start of maintenance period."
                    }
                  }
                }, 
                "null"
              ], 
              "description": "Maintenance period"
            }
          }
        }
      }
    }
  ]
}

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

Method PUT: Update settings

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

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "Settings for CELOG system", 
  "properties": {
    "heartbeat_interval": {
      "type": "string", 
      "description": "Interval between heartbeat events. \"daily\", \"weekly\", or \"monthly\"."
    }, 
    "storage_limit": {
      "type": "integer", 
      "description": "Storage limit in megabytes per terabyte of available storage"
    }, 
    "retention_days": {
      "type": "integer", 
      "description": "Retention period in days"
    }, 
    "maintenance": {
      "type": [
        {
          "type": "object", 
          "description": "Specifies start and duration of maintenance period during which no alerts will be sent for new eventgroups.", 
          "properties": {
            "duration": {
              "type": "integer", 
              "description": "Duration of maintenance period in seconds."
            }, 
            "start": {
              "type": "integer", 
              "description": "Start of maintenance period."
            }
          }
        }, 
        "null"
      ], 
      "description": "Maintenance period"
    }
  }
}

There is no JSON response body for this method.
