Protocols
Protocol-specific utility endpoints for Modbus, BACnet, OPC-DA, OPC-UA, SNMP, Haystack, and DNP3.
See also: Protocols documentation | Full API Reference for interactive testing and complete schemas.
Endpoints
| Method | Path | Description | Reference |
|---|---|---|---|
| GET | /bacnet/bulk | Get a list of current bulk BACnet operations | API Reference → |
| POST | /bacnet/bulk | Perform many BACnet operations using a Local Device | API Reference → |
| DELETE | /bacnet/bulk/{id} | Remove a bulk BACnet operation using its id | API Reference → |
| GET | /bacnet/bulk/{id} | Get the status of a bulk BACnet operation using its id | API Reference → |
| POST | /bacnet/bulk/{id} | Cancel a bulk BACnet operation using its id | API Reference → |
| GET | /bacnet/local-devices | Query the local devices | API Reference → |
| POST | /bacnet/local-devices | Create new local device | API Reference → |
| DELETE | /bacnet/local-devices/{id} | Delete a local device | API Reference → |
| GET | /bacnet/local-devices/{id} | Get local device by id | API Reference → |
| PUT | /bacnet/local-devices/{id} | Update an existing local device | API Reference → |
| POST | /bacnet/local-devices/register-foreign-device/{id} | Register an existing BACnet IP local device to a BBMD | API Reference → |
| GET | /bacnet/object-properties/{objectType} | Get the possible properties for an object id | API Reference → |
| GET | /bacnet/object-types | Get all supported object types | API Reference → |
| POST | /bacnet/read | Read property values from a device/object | API Reference → |
| POST | /bacnet/read-object-list | Read the list of objects from a device | API Reference → |
| POST | /bacnet/read-property-list | Read the list of properties from a device/object | API Reference → |
| POST | /bacnet/whois | Discover devices via Who-Is | API Reference → |
| POST | /bacnet/write | Write property values to a device/object | API Reference → |
| GET | /grpc-data-source/connected-publishers | List all gRPC publishers currently connected to this data source | API Reference → |
| DELETE | /grpc-data-source/connected-publishers/{publisherXid} | Disconnect and remove a connected gRPC publisher | API Reference → |
| GET | /grpc-data-source/status/{xid} | Get the runtime status of a gRPC data source | API Reference → |
| GET | /haystack-ds/{xid}/haystack-ids | Gets a list of Haystack IDs for a DS and their point XIDs | API Reference → |
| POST | /haystack-ds/{xid}/history-import | Import history for all data points, requires data source permission | API Reference → |
| GET | /haystack-ds/{xid}/read/{filter} | Read a haystack database as JSON using a filter | API Reference → |
| GET | /haystack-ds/history-import-results/{id} | Check the status of a history import | API Reference → |
| GET | /haystack-rest/{database}/{operation} | Execute a Haystack REST operation against a database | API Reference → |
| POST | /modbus/ip/locator | Modbus IP Locator | API Reference → |
| POST | /modbus/ip/read | Modbus IP Read | API Reference → |
| POST | /modbus/ip/read-raw | Modbus IP read raw | API Reference → |
| POST | /modbus/ip/write | Modbus IP Write | API Reference → |
| POST | /modbus/ip/write-raw | Modbus IP write raw | API Reference → |
| GET | /modbus/log-file-path/{xid} | Get logfile name | API Reference → |
| POST | /modbus/read-generic | Modbus IP or Serial read, returns raw data and typed values | API Reference → |
| POST | /modbus/scan | Modbus scan with websocket support | API Reference → |
| DELETE | /modbus/scan/{id} | Remove a Modbus scan using its id | API Reference → |
| GET | /modbus/scan/{id} | Get the status of Modbus scan using its id | API Reference → |
| PUT | /modbus/scan/{id} | Cancel a Modbus scan using its id | API Reference → |
| POST | /modbus/serial/locator | Modbus Serial Locator | API Reference → |
| POST | /modbus/serial/read | Modbus Serial Read | API Reference → |
| POST | /modbus/serial/read-raw | Modbus Serial read raw | API Reference → |
| POST | /modbus/serial/write | Modbus Serial Write | API Reference → |
| POST | /modbus/serial/write-raw | Modbus Serial write raw | API Reference → |
| POST | /modbus/write-generic | Modbus IP or Serial write, writes raw data or typed values | API Reference → |
| POST | /opcda-data-source/list-servers | List available servers | API Reference → |
| POST | /opcda-data-source/list-tags | List tags within a server | API Reference → |
| GET | /snmp/{xid}/oids | Gets a list of SNMP oids for a DS and their point XIDs | API Reference → |
| POST | /snmp/get-oid | Get single OID | API Reference → |
| GET | /snmp/get-oid/{dataSourceXid} | Get single OID with data source settings | API Reference → |
| POST | /snmp/mib-walk/{dataSourceXid} | Upload a mib file | API Reference → |
| POST | /snmp/set-oid | Set single OID using SNMPv1 | API Reference → |
| POST | /snmp/set-oid/{dataSourceXid} | Set single OID using data source settings | API Reference → |
| POST | /snmp/walk | SNMP Walk | API Reference → |
| DELETE | /snmp/walk-status/{resourceId} | Cancel SNMP Walk | API Reference → |
| GET | /snmp/walk-status/{resourceId} | Get SNMP Walk results | API Reference → |
| POST | /snmp/walk/{dataSourceXid} | SNMP Walk | API Reference → |