Powered by Redocly

/config/remote/{name}

The configuration of a remote device.

Get /config/remote/{name}

SecurityApiKey
Request
path Parameters
name
required
string

The name of a remote device. It must consist of printable characters only. The name local is reserved for internal use and may not appear here.

Example: PRM3
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/remote/{name}
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}
Replace /config/remote/{name}
SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a remote device.  It must consist of printable
characters only.  The name local is reserved for internal use
and may not appear here.


 
 Example:  PRM3
Request Body schema: application/json
address
string (configRemoteNameAddress) 
The address of the remote device.  The meaning of this value
depends on the link-type.


 
link_type
string (configRemoteNameLinkType) 
The link-type of the remote device.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/remote/{name}
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/remote/{name}
SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a remote device.  It must consist of printable
characters only.  The name local is reserved for internal use
and may not appear here.


 
 Example:  PRM3
Request Body schema: application/json
address
string (configRemoteNameAddress) 
The address of the remote device.  The meaning of this value
depends on the link-type.


 
link_type
string (configRemoteNameLinkType) 
The link-type of the remote device.


 
Responses 
200
Normal response.


401
Unauthorized response.


post/config/remote/{name}
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/remote/{name}
Delete the remote device configuration and the physical registers
associated with it.


SecurityApiKey 
Request 
path Parameters
name
required
string
The name of a remote device.  It must consist of printable
characters only.  The name local is reserved for internal use
and may not appear here.


 
 Example:  PRM3
Responses 
200
Normal response.


401
Unauthorized response.


delete/config/remote/{name}
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/remote/{name}/address