Server Threads Settings Update

Updates server thread pool settings.

Request

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

Request

bash

curl -X PATCH "{BASE_URL}/api/server/settings/threads" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

Request Body

Parameter	Type	Required	Description
`data.attributes.autoMode`	boolean	No	Automatic thread count mode
`data.attributes.workerThreadCount`	integer	No	Number of worker threads
`data.attributes.readerThreadCount`	integer	No	Number of reader threads
`data.attributes.writerThreadCount`	integer	No	Number of writer threads
`data.attributes.transportThreadCount`	integer	No	Number of transport threads

Note: When autoMode is true, thread count fields cannot be modified. When changing autoMode from true to false, all thread count fields must be provided. When autoMode is already false, thread counts can be partially updated.

Request Body - Auto Mode

json

{
  "data": {
    "attributes": {
      "autoMode": true
    }
  }
}

Request Body - Switch to Manual Mode

json

{
  "data": {
    "attributes": {
      "autoMode": false,
      "workerThreadCount": 96,
      "readerThreadCount": 48,
      "writerThreadCount": 144,
      "transportThreadCount": 96
    }
  }
}

Request Body - Partial Update in Manual Mode

json

{
  "data": {
    "attributes": {
      "readerThreadCount": 48,
      "transportThreadCount": 96
    }
  }
}

Response Body

Thread Settings

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

Successful Response (200) - Auto Mode Enabled

json

{
  "data": {
    "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
      }
    }
  },
  "meta": {
    "executionTime": 25,
    "generatedAt": 1764851122674
  },
  "message": "Thread Settings have been updated"
}

Successful Response (200) - Manual Mode

json

{
  "data": {
    "attributes": {
      "autoMode": {
        "editable": true,
        "value": false
      },
      "workerThreadCount": {
        "editable": true,
        "value": 96
      },
      "readerThreadCount": {
        "editable": true,
        "value": 48
      },
      "writerThreadCount": {
        "editable": true,
        "value": 144
      },
      "transportThreadCount": {
        "editable": true,
        "value": 96
      }
    }
  },
  "meta": {
    "executionTime": 18,
    "generatedAt": 1764851159824
  },
  "message": "Thread Settings have been updated"
}

Error Responses (4xx/5xx)

Validation Error (400)

Parameter	Type	Description
`message`	string	Human-readable error message
`errors.attributes.workerThreadCount`	string[]	Validation errors for workerThreadCount field
`errors.attributes.readerThreadCount`	string[]	Validation errors for readerThreadCount field
`errors.attributes.writerThreadCount`	string[]	Validation errors for writerThreadCount field
`errors.attributes.transportThreadCount`	string[]	Validation errors for transportThreadCount field

Validation Error

json

{
  "message": "Validation failed",
  "errors": {
    "attributes": {
      "workerThreadCount": [
        "Cannot set thread count when autoMode is enabled"
      ],
      "readerThreadCount": [
        "Cannot set thread count when autoMode is enabled"
      ],
      "writerThreadCount": [
        "Cannot set thread count when autoMode is enabled"
      ],
      "transportThreadCount": [
        "Cannot set thread count when autoMode is enabled"
      ]
    }
  }
}

Error Response

json

{
  "message": "Error message"
}

Support Needed?

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