Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Device I/O

Retrieves the device port.

get/devices/{deviceId}/io/ports/{portId}

Query parameters

includestring[]

Allows clients to request optional information such us URLs necessary to configure third party IDPs.

Response

Successfully fetched.

idstring required

Unique ID for the port.

enabledboolean required

If the port is not enabled, no events will be created, and the icon will not show up in the live stream.

namestring required

Human changeable name of the port, defaults to value of the id field.

type'input' | 'output' required

Denotes whether this is an input or output port.

idleCircuitState'open' | 'closed' required

Indicates the normal, inactive or idle, state of the connected circuit. Possible values:

  • open: means the port is "off" when in idle state (open circuit; has no voltage), and the port state being active means it is turned "on" (circuit is closed; has voltage).
  • closed: means the port is "on" when in idle state (closed circuit; has voltage), and the port state being active means it is turned "off" (open circuit; has no voltage).

Example response

{
  "id": "1",
  "name": "Input 1"
}