Products Solutions Developer Pricing Get For Free Download Sign in Sign up
Show topics

Server Advanced Settings Update

Updates server advanced settings.

Request

Property Value
Method PATCH
URL /api/server/settings/advanced
Content-Type application/json
Authentication Bearer Token

Request Body

Parameter Type Required Description
data.attributes.reuseAddresses boolean No Reuse socket addresses
data.attributes.tcpNoDelay boolean No TCP no delay option
data.attributes.cpuMonitoring string No CPU monitoring mode
data.attributes.loadProbeInterval integer No Load probe interval in seconds
data.attributes.loadAnalyseInterval integer No Load analysis interval in seconds

Example Request

{
  "data": {
    "attributes": {
      "reuseAddresses": true,
      "tcpNoDelay": true,
      "cpuMonitoring": "SYSTEM",
      "loadProbeInterval": 2,
      "loadAnalyseInterval": 5
    }
  }
}

Response

Status Codes

Code Description
200 Success - Settings updated
400 Bad Request - Invalid parameters
401 Unauthorized - Invalid or missing token
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error

Successful Response (200)

{
  "data": {
    "attributes": {
      "reuseAddresses": {
        "editable": true,
        "value": true
      },
      "tcpNoDelay": {
        "editable": true,
        "value": true
      },
      "cpuMonitoring": {
        "editable": true,
        "value": "SYSTEM"
      },
      "loadProbeInterval": {
        "editable": true,
        "value": 2
      },
      "loadAnalyseInterval": {
        "editable": true,
        "value": 5
      }
    }
  },
  "meta": {
    "executionTime": 21,
    "generatedAt": 1764852073002
  },
  "message": "Advanced Settings have been updated"
}

Response Body

Advanced Settings

Parameter Type Description
data.attributes.reuseAddresses.value boolean Reuse socket addresses
data.attributes.reuseAddresses.editable boolean Indicates if the field can be modified
data.attributes.reuseAddresses.lockedBy string Locked by environment variable (if present)
data.attributes.tcpNoDelay.value boolean TCP no delay option
data.attributes.tcpNoDelay.editable boolean Indicates if the field can be modified
data.attributes.tcpNoDelay.lockedBy string Locked by environment variable (if present)
data.attributes.cpuMonitoring.value string CPU monitoring mode
data.attributes.cpuMonitoring.editable boolean Indicates if the field can be modified
data.attributes.cpuMonitoring.lockedBy string Locked by environment variable (if present)
data.attributes.loadProbeInterval.value integer Load probe interval in seconds
data.attributes.loadProbeInterval.editable boolean Indicates if the field can be modified
data.attributes.loadProbeInterval.lockedBy string Locked by environment variable (if present)
data.attributes.loadAnalyseInterval.value integer Load analysis interval in seconds
data.attributes.loadAnalyseInterval.editable boolean Indicates if the field can be modified
data.attributes.loadAnalyseInterval.lockedBy string Locked by environment variable (if present)
message string Response status message

Metadata

Parameter Type Description
meta.executionTime integer Request processing time in milliseconds
meta.generatedAt integer Response generation timestamp (Unix timestamp in ms)

Error Response (4xx/5xx)

{
  "message": "Error message"
}

Error Response Body

Parameter Type Description
message string Human-readable error message