Server Settings

Returns all server configuration settings.

Request

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

Request

bash

curl -X GET "{BASE_URL}/api/server/settings" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

Code	Description
200	Success
401	Unauthorized - Invalid or missing token
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error

Identity Settings

Parameter	Type	Description
`data.identitySettings.attributes.serverName.value`	string	Server display name
`data.identitySettings.attributes.serverName.editable`	boolean	Indicates if the field can be modified
`data.identitySettings.attributes.serverName.lockedBy`	string	Locked by environment variable (if present)
`data.identitySettings.attributes.hostName.value`	string	Server hostname
`data.identitySettings.attributes.hostName.editable`	boolean	Indicates if the field can be modified
`data.identitySettings.attributes.hostName.lockedBy`	string	Locked by environment variable (if present)
`data.identitySettings.attributes.groupName.value`	string	Server group name
`data.identitySettings.attributes.groupName.editable`	boolean	Indicates if the field can be modified
`data.identitySettings.attributes.groupName.lockedBy`	string	Locked by environment variable (if present)

Thread Settings

Parameter	Type	Description
`data.threadSettings.attributes.autoMode.value`	boolean	Automatic thread count mode
`data.threadSettings.attributes.autoMode.editable`	boolean	Indicates if the field can be modified
`data.threadSettings.attributes.autoMode.lockedBy`	string	Locked by environment variable (if present)
`data.threadSettings.attributes.workerThreadCount.value`	integer	Number of worker threads
`data.threadSettings.attributes.workerThreadCount.editable`	boolean	Indicates if the field can be modified
`data.threadSettings.attributes.workerThreadCount.lockedBy`	string	Locked by environment variable (if present)
`data.threadSettings.attributes.readerThreadCount.value`	integer	Number of reader threads
`data.threadSettings.attributes.readerThreadCount.editable`	boolean	Indicates if the field can be modified
`data.threadSettings.attributes.readerThreadCount.lockedBy`	string	Locked by environment variable (if present)
`data.threadSettings.attributes.writerThreadCount.value`	integer	Number of writer threads
`data.threadSettings.attributes.writerThreadCount.editable`	boolean	Indicates if the field can be modified
`data.threadSettings.attributes.writerThreadCount.lockedBy`	string	Locked by environment variable (if present)
`data.threadSettings.attributes.transportThreadCount.value`	integer	Number of transport threads
`data.threadSettings.attributes.transportThreadCount.editable`	boolean	Indicates if the field can be modified
`data.threadSettings.attributes.transportThreadCount.lockedBy`	string	Locked by environment variable (if present)

REST Settings

Parameter	Type	Description
`data.restSettings.attributes.enabled.value`	boolean	REST API enabled
`data.restSettings.attributes.enabled.editable`	boolean	Indicates if the field can be modified
`data.restSettings.attributes.enabled.lockedBy`	string	Locked by environment variable (if present)
`data.restSettings.attributes.apiKey.value`	string	API key for authentication
`data.restSettings.attributes.apiKey.editable`	boolean	Indicates if the field can be modified
`data.restSettings.attributes.apiKey.lockedBy`	string	Locked by environment variable (if present)
`data.restSettings.attributes.ipWhiteList.value`	string[]	List of whitelisted IP addresses
`data.restSettings.attributes.ipWhiteList.editable`	boolean	Indicates if the field can be modified
`data.restSettings.attributes.ipWhiteList.lockedBy`	string	Locked by environment variable (if present)
`data.restSettings.attributes.corsSettings.enabled.value`	boolean	CORS enabled
`data.restSettings.attributes.corsSettings.enabled.editable`	boolean	Indicates if the field can be modified
`data.restSettings.attributes.corsSettings.enabled.lockedBy`	string	Locked by environment variable (if present)
`data.restSettings.attributes.corsSettings.allowedOrigins.value`	string[]	List of allowed CORS origins
`data.restSettings.attributes.corsSettings.allowedOrigins.editable`	boolean	Indicates if the field can be modified
`data.restSettings.attributes.corsSettings.allowedOrigins.lockedBy`	string	Locked by environment variable (if present)

Advanced Settings

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

Virtual Host Settings

Parameter	Type	Description
`data.vhostSettings.list`	array	List of virtual host configurations
`data.vhostSettings.list[].id`	integer	Virtual host ID
`data.vhostSettings.list[].attributes.host.value`	string	Host binding (`"*"` for all interfaces)
`data.vhostSettings.list[].attributes.host.editable`	boolean	Indicates if the field can be modified
`data.vhostSettings.list[].attributes.host.lockedBy`	string	Locked by environment variable (if present)
`data.vhostSettings.list[].attributes.port.value`	integer	Port number
`data.vhostSettings.list[].attributes.port.editable`	boolean	Indicates if the field can be modified
`data.vhostSettings.list[].attributes.port.lockedBy`	string	Locked by environment variable (if present)
`data.vhostSettings.list[].attributes.protocols.value`	string[]	Enabled protocols
`data.vhostSettings.list[].attributes.protocols.editable`	boolean	Indicates if the field can be modified
`data.vhostSettings.list[].attributes.protocols.lockedBy`	string	Locked by environment variable (if present)
`data.vhostSettings.list[].attributes.isSSL.value`	boolean	SSL enabled
`data.vhostSettings.list[].attributes.isSSL.editable`	boolean	Indicates if the field can be modified
`data.vhostSettings.list[].attributes.isSSL.lockedBy`	string	Locked by environment variable (if present)
`data.vhostSettings.list[].attributes.isControlPanel.value`	boolean	Control panel endpoint
`data.vhostSettings.list[].attributes.isControlPanel.editable`	boolean	Indicates if the field can be modified
`data.vhostSettings.list[].attributes.isControlPanel.lockedBy`	string	Locked by environment variable (if present)

Parameters Settings

Parameter	Type	Description
`data.parametersSettings.list`	array	List of custom parameters
`data.parametersSettings.list[].id`	integer	Parameter ID
`data.parametersSettings.list[].attributes.name.value`	string	Parameter name
`data.parametersSettings.list[].attributes.name.editable`	boolean	Indicates if the field can be modified
`data.parametersSettings.list[].attributes.name.lockedBy`	string	Locked by environment variable (if present)
`data.parametersSettings.list[].attributes.value.value`	string	Parameter value
`data.parametersSettings.list[].attributes.value.editable`	boolean	Indicates if the field can be modified
`data.parametersSettings.list[].attributes.value.lockedBy`	string	Locked by environment variable (if present)

Metadata

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

Successful Response (200)

json

{
  "data": {
    "identitySettings": {
      "attributes": {
        "serverName": { "editable": true, "value": "Server 2" },
        "hostName": { "editable": true, "value": "stormdev2.web-anatomy.com" },
        "groupName": { "editable": true, "value": "Premise" }
      }
    },
    "threadSettings": {
      "attributes": {
        "autoMode": { "editable": true, "value": true },
        "workerThreadCount": { "lockedBy": "autoMode", "editable": false, "value": 96 },
        "readerThreadCount": { "lockedBy": "autoMode", "editable": false, "value": 48 },
        "writerThreadCount": { "lockedBy": "autoMode", "editable": false, "value": 144 },
        "transportThreadCount": { "lockedBy": "autoMode", "editable": false, "value": 96 }
      }
    },
    "restSettings": {
      "attributes": {
        "enabled": { "editable": true, "value": true },
        "apiKey": { "editable": true, "value": "blablabla" },
        "ipWhiteList": { "editable": true, "value": [] },
        "corsSettings": {
          "enabled": { "editable": true, "value": false },
          "allowedOrigins": { "editable": true, "value": ["*"] }
        }
      }
    },
    "advancedSettings": {
      "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 }
      }
    },
    "vhostSettings": {
      "list": [
        {
          "id": 0,
          "attributes": {
            "host": { "editable": true, "value": "*" },
            "port": { "editable": true, "value": 1935 },
            "protocols": { "editable": true, "value": ["RTMP"] },
            "isSSL": { "editable": true, "value": false },
            "isControlPanel": { "editable": true, "value": false }
          }
        },
        {
          "id": 1,
          "attributes": {
            "host": { "editable": true, "value": "127.0.0.1" },
            "port": { "editable": true, "value": 8080 },
            "protocols": { "editable": true, "value": ["WEBSOCKETS", "HTTP"] },
            "isSSL": { "editable": true, "value": false },
            "isControlPanel": { "editable": true, "value": true }
          }
        }
      ]
    },
    "parametersSettings": {
      "list": [
        {
          "id": 0,
          "attributes": {
            "name": { "editable": true, "value": "l0dead" },
            "value": { "editable": true, "value": "enabled" }
          }
        },
        {
          "id": 1,
          "attributes": {
            "name": { "editable": true, "value": "devpanel" },
            "value": { "editable": true, "value": "enabled" }
          }
        }
      ]
    }
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1764847868009
  }
}

Error Response (4xx/5xx)

Parameter	Type	Description
`message`	string	Human-readable error message

Error Response

json

{
  "message": "Error message"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.