Powered by Redocly

/config/modbus/client/map/{name}/option/{opt}

The value of the Modbus map option.

Get /config/modbus/client/map/{name}/option/{opt}

SecurityApiKey
Request
path Parameters
name
required
string

The name of a user Modbus map (editable).

Example: my_modbus_map
opt
required
string

The name of a Modbus map option.

Enum: "default-modbus-addr" "default-serial-params" "default-tcp-port"
Responses
200

Normal response.

401

Unauthorized response.

get/config/modbus/client/map/{name}/option/{opt}
Request samples 
Response samples 
application/json
{
  • "result": "9600/8n1",
  • "error": "Error message (present if an error occurred)."
}
Replace /config/modbus/client/map/{name}/option/{opt}
SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a user Modbus map (editable).


 
 Example:  my_modbus_map
opt
required
string
The name of a Modbus map option.


 Enum: "default-modbus-addr" "default-serial-params" "default-tcp-port"  
Request Body schema: application/json
string (configModbusClientMapNameOptionOpt) 
The value of the Modbus map option.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/modbus/client/map/{name}/option/{opt}
Request samples 
application/json
"9600/8n1"
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/modbus/client/map/{name}/option/{opt}
SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a user Modbus map (editable).


 
 Example:  my_modbus_map
opt
required
string
The name of a Modbus map option.


 Enum: "default-modbus-addr" "default-serial-params" "default-tcp-port"  
Request Body schema: application/json
string (configModbusClientMapNameOptionOpt) 
The value of the Modbus map option.


 
Responses 
200
Normal response.


401
Unauthorized response.


post/config/modbus/client/map/{name}/option/{opt}
Request samples 
application/json
"9600/8n1"
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/modbus/client/map/{name}/option/{opt}
Delete this option.


SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a user Modbus map (editable).


 
 Example:  my_modbus_map
opt
required
string
The name of a Modbus map option.


 Enum: "default-modbus-addr" "default-serial-params" "default-tcp-port"  
Responses 
200
Normal response.


401
Unauthorized response.


delete/config/modbus/client/map/{name}/option/{opt}
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/modbus/client/map/{name}/reg