/config/remote/{name}/address

The address of the remote device. The meaning of this value depends on the link-type.

Get /config/remote/{name}/address

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.

get/config/remote/{name}/address
Request samples
Response samples
application/json
{
  • "result": "modbus://sunspec.1@USB2",
  • "error": "Error message (present if an error occurred)."
}

Replace /config/remote/{name}/address

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
string (configRemoteNameAddress)

The address of the remote device. The meaning of this value depends on the link-type.

Responses
200

Normal response.

401

Unauthorized response.

put/config/remote/{name}/address
Request samples
application/json
"modbus://sunspec.1@USB2"
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Update /config/remote/{name}/address

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
string (configRemoteNameAddress)

The address of the remote device. The meaning of this value depends on the link-type.

Responses
200

Normal response.

401

Unauthorized response.

post/config/remote/{name}/address
Request samples
application/json
"modbus://sunspec.1@USB2"
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Delete /config/remote/{name}/address

Reset to empty string.

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}/address
Request samples
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}