/config/remote

The remote device configurations.

Get /config/remote

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

Replace /config/remote

SecurityApiKey
Request
Request Body schema: application/json
additional property
object (configRemoteName)

The configuration of a remote device.

Responses
200

Normal response.

401

Unauthorized response.

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

Update /config/remote

SecurityApiKey
Request
Request Body schema: application/json
additional property
object (configRemoteName)

The configuration of a remote device.

Responses
200

Normal response.

401

Unauthorized response.

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

Delete /config/remote

Deletes all remote device configurations and the physical registers using them.

SecurityApiKey
Responses
200

Normal response.

401

Unauthorized response.

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