Powered by Redocly

/config/modbus/client/map/{name}/reg/{idx}/access

The access-mode of the register. It must be one of:

  • ro: read-only
  • rw: read-write

Get /config/modbus/client/map/{name}/reg/{idx}/access

SecurityApiKey
Request
path Parameters
name
required
string

The name of a user Modbus map (editable).

Example: my_modbus_map
idx
required
string

The index of a Modbus map register.

Responses
200

Normal response.

401

Unauthorized response.

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


 
 Example:  my_modbus_map
idx
required
string
The index of a Modbus map register.


 
Request Body schema: application/json
string (configModbusClientMapNameRegItemAccess) 
The access-mode of the register.  It must be one of:


    

  • ro: read-only
    • 

  • rw: read-write
    • 



 Enum: "ro" "rw"  
Responses 
200
Normal response.


401
Unauthorized response.


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


 
 Example:  my_modbus_map
idx
required
string
The index of a Modbus map register.


 
Request Body schema: application/json
string (configModbusClientMapNameRegItemAccess) 
The access-mode of the register.  It must be one of:


    

  • ro: read-only
    • 

  • rw: read-write
    • 



 Enum: "ro" "rw"  
Responses 
200
Normal response.


401
Unauthorized response.


post/config/modbus/client/map/{name}/reg/{idx}/access
Request samples 
application/json
"ro"
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/modbus/client/map/{name}/reg/{idx}/access
Reset to rw.


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


 
 Example:  my_modbus_map
idx
required
string
The index of a Modbus map register.


 
Responses 
200
Normal response.


401
Unauthorized response.


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