/config/modbus/server/tcp

The TCP protocol configuration.

Get /config/modbus/server/tcp

SecurityApiKey
Request
query Parameters
max-depth
integer >= 1

Limit output depth of the response. See Max-Depth.

Example: max-depth=2
filter
string

Response filter string. See Filter-Spec.

Example: filter={foo,bar}
Responses
200

Normal response.

401

Unauthorized response.

get/config/modbus/server/tcp
Request samples
Response samples
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}

Replace /config/modbus/server/tcp

SecurityApiKey
Request
Request Body schema: application/json
port
integer (configModbusServerTcpPort) [ 0 .. 65535 ]

The IP port of the Modbus server. The default value is 502.

Responses
200

Normal response.

401

Unauthorized response.

put/config/modbus/server/tcp
Request samples
application/json
{ }
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Update /config/modbus/server/tcp

SecurityApiKey
Request
Request Body schema: application/json
port
integer (configModbusServerTcpPort) [ 0 .. 65535 ]

The IP port of the Modbus server. The default value is 502.

Responses
200

Normal response.

401

Unauthorized response.

post/config/modbus/server/tcp
Request samples
application/json
{ }
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Delete /config/modbus/server/tcp

Reset to default. See the descriptions of the individual endpoints for their default values. Commonly, arrays and strings are cleared to empty, numbers are cleared to 0, and booleans are cleared to false.

SecurityApiKey
Responses
200

Normal response.

401

Unauthorized response.

delete/config/modbus/server/tcp
Request samples
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}