5.5.1 api io caps

The /api/io/caps function returns a list of available hardware inputs and outputs (ports) of the device. Define the input/output in the optional port parameter. If the port parameter is not included, settings of all the inputs and outputs are returned.

The function is part of the I/O service and the user must be assigned the I/O Monitoring privilege for authentication if required.

The GET or POST method can be used for this function.

Request parameters:

The reply is in the application/json format and includes a port list (ports) including current settings. If the port parameter is used, the ports field includes just one item.

Example:

GET /api/io/caps
{
  "success" : true,
  "result" : {
    "ports" : [
      {
        "port" : "relay1",
        "type" : "output"
      },
      {
        "port" : "relay2",
        "type" : "output"
      }
   ]
  }
}