Resource URL: /remote-service/<<version=5>>/esrs/settings/

    Overview: 

     Methods: GET, PUT

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

Method GET: List settings.

       URL: GET /remote-service/<<version=5>>/esrs/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"
        }
      }
    }, 
    {
      "type": "object", 
      "description": "View configured ESRS gateways, gateway access pools, alerting, and time periods", 
      "properties": {
        "alert_on_disconnect": {
          "type": "boolean", 
          "description": "Whether to generate a CELOG alert to notify when ESRS is disconnected from the gateway"
        }, 
        "download_chunk_size": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Chunk size in bytes for each download request", 
          "maximum": 4294967295
        }, 
        "download_timeout_period": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Timeout of an individual download chunk period in seconds", 
          "maximum": 4294967295
        }, 
        "secondary_esrs_gateway": {
          "type": "string", 
          "description": "IP address or hostname of ESRS gateway"
        }, 
        "download_error_retries": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Number of error or timeout retries per download chunk", 
          "maximum": 4294967295
        }, 
        "download_filesystem_limit": {
          "minimum": 0, 
          "type": "integer", 
          "description": "The percentage threshold of used space on the filesystem under which a download will be allowed.", 
          "maximum": 4294967295
        }, 
        "ui_reporting_period": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Usage Intelligence reporting period in seconds (how often to generate and send a licensing Usage Intelligence report)", 
          "maximum": 4294967295
        }, 
        "download_enabled": {
          "type": "boolean", 
          "description": "Status of ESRS file download feature"
        }, 
        "gateway_access_pools": {
          "items": {
            "type": "string", 
            "description": "Identifier for a valid ESRS-accessible pool"
          }, 
          "type": "array"
        }, 
        "primary_esrs_gateway": {
          "type": "string", 
          "description": "IP address or hostname of ESRS gateway"
        }, 
        "connectivity_check_period": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Connectivity status check heartbeat period in seconds (tests the connectivity from cluster to gateway)", 
          "maximum": 4294967295
        }
      }
    }
  ]
}

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

Method PUT: Modify one or more settings.

       URL: PUT /remote-service/<<version=5>>/esrs/settings/

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "Modify ESRS gateways, gateway access pools, alerting, and time periods", 
  "properties": {
    "alert_on_disconnect": {
      "type": "boolean", 
      "description": "Whether to generate a CELOG alert to notify when ESRS is disconnected from the gateway"
    }, 
    "download_chunk_size": {
      "minimum": 0, 
      "type": "integer", 
      "description": "Chunk size in bytes for each download request", 
      "maximum": 4294967295
    }, 
    "download_timeout_period": {
      "minimum": 0, 
      "type": "integer", 
      "description": "Timeout of an individual download chunk period in seconds", 
      "maximum": 4294967295
    }, 
    "secondary_esrs_gateway": {
      "type": "string", 
      "description": "IP address or hostname of ESRS gateway"
    }, 
    "download_error_retries": {
      "minimum": 0, 
      "type": "integer", 
      "description": "Number of error or timeout retries per download chunk", 
      "maximum": 4294967295
    }, 
    "download_filesystem_limit": {
      "minimum": 0, 
      "type": "integer", 
      "description": "The percentage threshold of used space on the filesystem under which a download will be allowed.", 
      "maximum": 4294967295
    }, 
    "ui_reporting_period": {
      "minimum": 0, 
      "type": "integer", 
      "description": "Usage Intelligence reporting period in seconds (how often to generate and send a licensing Usage Intelligence report)", 
      "maximum": 4294967295
    }, 
    "download_enabled": {
      "type": "boolean", 
      "description": "Status of ESRS file download feature"
    }, 
    "gateway_access_pools": {
      "items": {
        "type": "string", 
        "description": "Identifier for a valid ESRS-accessible pool"
      }, 
      "type": "array"
    }, 
    "primary_esrs_gateway": {
      "type": "string", 
      "description": "IP address or hostname of ESRS gateway"
    }, 
    "connectivity_check_period": {
      "minimum": 0, 
      "type": "integer", 
      "description": "Connectivity status check heartbeat period in seconds (tests the connectivity from cluster to gateway)", 
      "maximum": 4294967295
    }
  }
}

There is no response body for this method.
