Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Home
  • Knowledge base
  • Contact Us
  • Home
  • Developers
  • API documentation

Connector names in the API

This article provides a list of the various Connector names that is being used in the internal REST API

Written by Mads Mikkelsen

Updated at August 15th, 2024

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Installation & Technical information
    Introduction SIA Connect Standalone SIA Connect ANY-Ware Cellular & WiFi connectivity
  • Configuration in the Web UI
    Getting started with the UI Connectors Instances Items Mapping Data System Network Tools & Add-ons DigiCert IoT Trust Manager
  • Connectors
    Siemens S7 Azure IoT Ethernet/IP Mitsubishi MELSEC OPC-UA Server SQL MQTT Omron Host Link REST API Omron FINS Keyence Beckhoff TwinCAT BACnet Virtual OPC-UA Client MS SQL File M-Bus Modbus
  • Scripting & Variables
    Data formatting
  • Developers
    API documentation Shadow API
  • Tutorials & Guides
    InfluxDB AWS IoT Core - Amazon Web Services Microsoft Power BI KaaIoT Siemens S7 AVEVA Insight SIA Connect Demo Rack Grafana Azure
  • General
+ More

Articles in this section:

  • Internal REST API Reference
  • Connector names in the API

When using the internal REST API you often needs to refer to the Connector which has a different internal name than the visual title the user sees in the portal.

An example of an API endpoint could be /api/plugins/{connector_name} which would show you all the meta data of the Connector and its Instances and Item. The {connector_name} would refer to the internal name of the Connector which is being shown in below table:

 

Title of Connector Internal name of Connector
Ethernet/IP ab_eip
BACnet IP bacnet_ip
BACnet MS/TP bacnet_mstp
Beckhoff TwinCAT beckhoff_twincat
CAMP NITP camp_nitp
IFM VSE ifm_vse
Keyence KV keyence_kv
Mitsubishi MELSEC melsec
Modbus TCP modbus_tcp
Modbus RTU modbus_rtu
Modbus RTU over TCP modbus_rtu_tcp
MBus mbus
W-MBus wmbus
OPC-UA Client opc_ua_client
OPC-UA Server opc_ua_server
Siemens S7 siemens_s7
Siemens LOGO siemens_logo
(Demo) Random number random_number
Omron FINS omron_fins
Omron Host Link omronhostlink
Universal Robot universal_robot
Virtual virtual

 

Title of Connector Internal name of Connector
Azure IoT azure_iot
FILE file
MS SQL mssql
MQTT mqtt
MySQL mysql
PostgreSQL psql
Pulsar pulsar
REST API rest_api
Siemens Mindsphere siemens_mindsphere

 

api connectors connector api

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • BACnet IP - Instance & item setup
  • Item variables
  • Item parameters

0
0
Expand