LogoLogo
Contact Uscybus.io
Connectware 1.10.2
Connectware 1.10.2
  • Getting Started
    • Introduction
    • System Requirements
    • Connectware Admin UI
    • Basic Components of Connectware
    • Connecting your First Machine
      • Your First Service Commissioning File
  • Documentation
    • Installation and Upgrades
      • Installing Connectware
        • Installing Connectware (Kubernetes)
        • Installing Connectware (Docker)
      • Upgrading Connectware
        • Upgrading Connectware (Kubernetes)
          • Version-Specific Upgrades (Kubernetes)
        • Upgrading Connectware (Docker)
          • Version-Specific Upgrades (Docker)
      • Uninstalling Connectware
        • Uninstalling Connectware (Kubernetes)
        • Uninstalling Connectware (Docker)
      • Licensing
    • User Management
      • Users and Roles View
      • Users
      • Roles
      • Permissions
      • Password Policy Rules
      • Default Admin User
      • MQTT Users
      • Adding a MQTT Publish Prefix for Users
      • Multi-Factor Authentication
      • Single Sign-On (SS0)
        • Single Sign-On with Microsoft Entra ID
        • Single Sign-On with LDAP
      • JSON Web Tokens
      • Access Permissions for Admin-UI
        • UI Access
        • Minimum Access Role Pages
    • Services
      • Service Overview
      • Service Resources View
        • Service Links View
        • Servers View
        • Containers View
        • Volumes View
        • Connections View
        • Endpoints View
        • Mappings View
      • Service Details View
      • Service Commissioning Files
        • Version
        • Description
        • Metadata
        • Parameters
        • Definitions
        • Resources
          • Cybus::Connection
          • Cybus::Container
            • Docker Problem with Network Changes
          • Cybus::Endpoint
          • Cybus::File
          • Cybus::IngressRoute
          • Cybus::Link
          • Cybus:Mapping
          • Cybus::Node
          • Cybus::Role
          • Cybus::Server
          • Cybus::User
          • Cybus::Volume
      • Setting Up and Configuring Services
        • Installing Services
        • Enabling Services
        • Updating Services
        • Disabling Services
        • Deleting Services
      • FlowSync
        • Example 1 - Node with Transaction Mode (HTTP)
        • Example 2 - Node Responds (HTTP)
        • Example 3 - Node with Error (HTTP)
        • Example 4 - Node with Timeout Error Code and Error Message (HTTP)
        • Example 5 - Full Transactional Data Flow (HTTP)
        • Example 6 - Full Transactional Data Flow (OPC UA)
      • ServiceID
      • Inter-Service Referencing
      • Deviation
      • Service Logs
        • Logs of Individual Services
        • Logs of All Services
      • Rule Engine
        • Data Processing Rules
        • Rule Sandbox
      • Shared Subscriptions
        • Setting Up Shared Subscriptions
    • Agents
      • Agents View
      • Installing Agents
        • Installing Agents via Docker
        • Installing Agents via Docker Compose
        • Installing Agents via Kubernetes
        • Using Mutual TLS for Agents
      • Registering Agents in Connectware
      • Using Agents
      • Monitoring Agents
      • Agents in Kubernetes
        • Adding Agents Inside your Connectware Installation
        • Remote Agents with the connectware-agent Helm Chart
        • Kubernetes Cluster Requirements for the connectware-agent Helm Chart
        • Installing Connectware Agents using the connectware-agent Helm Chart
        • Installing Connectware Agents without a License Key Using the connectware-agent Helm Chart
        • Upgrading the connectware-agent Helm Chart
        • Uninstalling Connectware agents with the connectware-agent Helm chart
        • Configuration Principles for the connectware-agent Helm Chart
        • Configuring Agents with the connectware-agent Helm Chart
          • Configuring Target Connectware for the connectware-agent Helm Chart
          • Configuring Agent Persistence for the connectware-agent Helm Chart
          • Configuring Compute Resources for the connectware-agent Helm Chart
          • Using a Custom Image Registry for the connectware-agent Helm Chart
          • Configuring Image Pull Policy for the connectware-agent Helm Chart
          • Using Mutual Transport Layer Security (mTLS) for agents with the connectware-agent Helm chart
          • Configuring image name and version for the connectware-agent Helm chart
          • Configuring Environment Variables for the connectware-agent Helm Chart
          • Configuring Labels and Annotations for the connectware-agent Helm Chart
          • Configuring podAntiAffinity for the connectware-agent Helm Chart
          • Assigning Agents to Kubernetes Nodes for the connectware-agent Helm Chart
          • Configuring Security Context for the connectware-agent Helm Chart
          • Controlling the Name of Kubernetes Objects for the connectware-agent Helm Chart
      • Troubleshooting Agents
    • Client Registry
      • Implicit Flow
      • Explicit Flow
      • Granting Access
    • Certificates
    • Monitoring
      • Data Explorer
      • Live Data
    • Workbench
      • Flows in Git Repositories
    • System Status
      • Info
      • Metrics
      • Status
      • Retrieving More System Information
      • System Health
    • Backup and Restore
      • Volumes
      • User Database
    • Connectware on Kubernetes
      • Connectware Helm Chart
      • Resizing Broker Volumes in Kubernetes
      • Configuring Core Services
      • LDAP Authentication
        • Configuring LDAP Authentication
        • Enabling TLS for LDAP Authentication
        • Manual Kubernetes Secret for LDAP Authentication Bind User
        • Customizing the Search Filter for LDAP Authentication
        • Customizing the User RDN for LDAP Authentication
      • Troubleshooting Connectware on Kubernetes
    • Environment Variables
    • Industry Protocol Details
      • ADS
        • ADS Connection Properties
        • ADS Endpoint Properties
      • BACnet
        • BACnet Connection Properties
        • BACnet Endpoint Properties
      • Custom Connectors
        • Developing Custom Connectors
        • Deploying Custom Connectors
        • Using Custom Connectors
      • EtherNet/IP
        • EtherNet/Ip Connection Properties
        • EtherNet/Ip Endpoint Properties
      • FOCAS
        • FOCAS Connection Properties
        • FOCAS Endpoint Properties
      • Hottinger Baldwin Messtechnik (HBM)
        • HBM Connection Properties
        • HBM Endpoint Properties
      • Heidenhain DNC
        • Heidenhain DNC Connection Properties
        • Heidenhain DNC Endpoint Properties
      • HTTP/REST
        • HTTP/REST Connection Properties
        • HTTP/REST Endpoint Properties
      • HTTP Server/Node
        • HTTP Server Properties
        • HTTP Node Properties
      • InfluxDB
        • InfluxDB Connection Properties
        • InfluxDB Endpoint Properties
      • Kafka
        • Kafka Connection Properties
        • Kafka Endpoint Properties
      • Modbus/TCP
        • Modbus/TCP Connection Properties
        • Modbus/TCP Endpoint Properties
      • MQTT
        • MQTT Connection Properties
        • MQTT Endpoint Properties
      • MSSQL
        • Mssql Connection Properties
        • Mssql Endpoint Properties
      • OPC DA
        • OPC DA Connection Properties
        • OPC DA Endpoint Properties
      • OPC UA
        • OPC UA Client
          • OPC UA Client Connection Properties
          • OPC UA Client Endpoint Properties
        • OPC UA Server
          • OPC UA Server Properties
          • OPC UA Node Properties
        • OPC UA Object Types
        • OPC UA Server References
          • OPC UA Reference Node
          • OPC UA Object Node
      • Siemens SIMATIC S7
        • Siemens S7 Connection Properties
        • Siemens S7 Endpoint Properties
      • Shdr
        • Shdr Connection Properties
        • Shdr Endpoint Properties
      • SINUMERIK
        • SINUMERIK Connection Properties
        • SINUMERIK Endpoint Properties
      • SOPAS
        • SOPAS Connection Properties
        • SOPAS Endpoint Properties
      • SQL
        • SQL Connection Properties
        • SQL Endpoint Properties
      • Werma WIN Ethernet
        • Werma WIN Ethernet Connection Properties
        • Werma WIN Ethernet Endpoint Properties
      • Systemstate
        • Systemstate Connection Properties
        • Systemstate Endpoint Properties
    • API Reference
      • User Management (API)
      • Client Registry (API)
      • Services (API)
      • Resources (API)
      • System Status (API)
      • Industry Protocol Details (API)
    • Changelog
      • General changes from 0.x to 1.0
        • Upgrading from 0.x to 1.0
Powered by GitBook
LogoLogo

Cybus

  • Terms and Condition
  • Imprint
  • Data Privacy

© Copyright 2025, Cybus GmbH

On this page

Was this helpful?

  1. Documentation
  2. API Reference

Industry Protocol Details (API)

PreviousSystem Status (API)NextChangelog

Last updated 23 days ago

Was this helpful?

20KB
Protocol Mapper Schema.yaml

Get all connection schemas

get
Responses
200
Connection schemas
application/json
Responseobject
get
GET /api/connections/schema HTTP/1.1
Host: 
Accept: */*
200

Connection schemas

{}

Get all connections

get
Responses
200
Array of connections
application/json
500
Failed to list all connections
get
GET /api/connections HTTP/1.1
Host: 
Accept: */*
[
  {
    "id": "text",
    "currentState": "connecting",
    "targetState": "connected",
    "connection": {},
    "agentName": "text"
  }
]

Get one connection by id

get
Responses
200
Sucessfully got a connection
application/json
500
Failed to get connection
get
GET /api/connections/{id} HTTP/1.1
Host: 
Accept: */*
{
  "id": "text",
  "currentState": "connecting",
  "targetState": "connected",
  "connection": {},
  "agentName": "text"
}

Get all endpoint schemas

get
Responses
200
Endpoint schemas
application/json
Responseobject
get
GET /api/endpoints/schema HTTP/1.1
Host: 
Accept: */*
200

Endpoint schemas

{}

Get all endpoints

get
Responses
200
Array of endpoints
application/json
500
Failed to list all endpoints
get
GET /api/endpoints HTTP/1.1
Host: 
Accept: */*
[
  {
    "id": "text",
    "currentState": "enabling",
    "targetState": "enabled",
    "connectionId": "text",
    "operation": "text",
    "address": {},
    "agentName": "text"
  }
]

Get one endpoint by id

get
Responses
200
Sucessfully got an Endpoint
application/json
500
Failed to get endpoint
get
GET /api/endpoints/{id} HTTP/1.1
Host: 
Accept: */*
{
  "id": "text",
  "currentState": "enabling",
  "targetState": "enabled",
  "connectionId": "text",
  "operation": "text",
  "address": {},
  "agentName": "text"
}

Get one endpoint topics by id

get
Responses
200
Sucessfully got an Endpoint topics
application/json
Responsestring[]
500
Failed to get endpoint topics
get
GET /api/endpoints/{id}/topics HTTP/1.1
Host: 
Accept: */*
[
  "text"
]

Get one endpoint state by id

get
Responses
200
Sucessfully got an Endpoint state
application/json
Responsestring
500
Failed to get endpoint state
get
GET /api/endpoints/{id}/state HTTP/1.1
Host: 
Accept: */*
text

Get all mapping schemas

get
Responses
200
Mapping schemas
application/json
Responseobject
get
GET /api/mappings/schema HTTP/1.1
Host: 
Accept: */*
200

Mapping schemas

{}

Get all mappings

get
Responses
200
Array of mappings
application/json
500
Failed to list all mappings
get
GET /api/mappings HTTP/1.1
Host: 
Accept: */*
[
  {
    "id": "text",
    "currentState": "enabling",
    "targetState": "enabled",
    "mappings": [
      {}
    ],
    "agentName": "text"
  }
]

Get one mapping by id

get
Responses
200
Sucessfully got an Mapping
application/json
500
Failed to get mapping
get
GET /api/mappings/{id} HTTP/1.1
Host: 
Accept: */*
{
  "id": "text",
  "currentState": "enabling",
  "targetState": "enabled",
  "mappings": [
    {}
  ],
  "agentName": "text"
}

Get endpoint topics for a given mapping

get
Responses
200
Sucessfully got the Mapping endpoint topics
application/json
500
Failed to get mapping endpoint topics
get
GET /api/mappings/{id}/endpoint-topics HTTP/1.1
Host: 
Accept: */*
{
  "ANY_ADDITIONAL_PROPERTY": [
    "text"
  ]
}

Get one mapping state by id

get
Responses
200
Sucessfully got an Mapping state
application/json
Responsestring
500
Failed to get mapping state
get
GET /api/mappings/{id}/state HTTP/1.1
Host: 
Accept: */*
text

Get all server schemas

get
Responses
200
Server schemas
application/json
Responseobject
get
GET /api/servers/schema HTTP/1.1
Host: 
Accept: */*
200

Server schemas

{}

Get all servers

get
Responses
200
Array of servers
application/json
500
Failed to list all servers
get
GET /api/servers HTTP/1.1
Host: 
Accept: */*
[
  {
    "id": "text",
    "options": {},
    "currentState": "enabling",
    "targetState": "enabled",
    "protocol": "Opcua",
    "agentName": "text"
  }
]

Get one server by id

get
Responses
200
Sucessfully got a Server
application/json
404
Server not found
500
Failed to get server
get
GET /api/servers/{id} HTTP/1.1
Host: 
Accept: */*
{
  "id": "text",
  "options": {},
  "currentState": "enabling",
  "targetState": "enabled",
  "protocol": "Opcua",
  "agentName": "text"
}

Get one server state by id

get
Responses
200
Sucessfully got a Server state
application/json
Responsestring
500
Failed to get server state
get
GET /api/servers/{id}/state HTTP/1.1
Host: 
Accept: */*
text

Get all nodes

get
Responses
200
Array of nodes
application/json
500
Failed to list all nodes
get
GET /api/nodes HTTP/1.1
Host: 
Accept: */*
[
  {
    "id": "text",
    "currentState": "enabling",
    "targetState": "enabled",
    "nodes": [
      {}
    ],
    "agentName": "text"
  }
]

Get one node state by id

get
Responses
200
Sucessfully got an Node state
application/json
Responsestring
500
Failed to get node state
get
GET /api/nodes/{id}/state HTTP/1.1
Host: 
Accept: */*
text

Get all available topics

get
Responses
200
Topics organized by their associated resources
application/json
500
Failed to list all available topics
get
GET /api/topics HTTP/1.1
Host: 
Accept: */*
{
  "endpoints": [
    {}
  ],
  "mappings": [
    {}
  ],
  "nodes": [
    {}
  ]
}
  • GETGet all connection schemas
  • GETGet all connections
  • GETGet one connection by id
  • PUTUpdate an existing connection
  • GETGet all endpoint schemas
  • GETGet all endpoints
  • GETGet one endpoint by id
  • GETGet one endpoint topics by id
  • GETGet one endpoint state by id
  • PUTUpdate an existing endpoint
  • GETGet all mapping schemas
  • GETGet all mappings
  • GETGet one mapping by id
  • PUTUpdate an existing mapping
  • GETGet endpoint topics for a given mapping
  • GETGet one mapping state by id
  • GETGet all server schemas
  • GETGet all servers
  • GETGet one server by id
  • PUTUpdate an existing servers
  • GETGet one server state by id
  • GETGet all nodes
  • GETGet one node state by id
  • GETGet all available topics
  • POSTExecute rule engine transformation

Update an existing connection

put
Body
operationstring · enumRequiredPossible values:
Responses
200
Updated connection
application/json
500
Failed to update the connection
put
PUT /api/connections/{id}/operation HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "operation": "connect"
}
{
  "id": "text",
  "currentState": "connecting",
  "targetState": "connected",
  "connection": {},
  "agentName": "text"
}

Update an existing endpoint

put
Body
operationstring · enumRequiredPossible values:
Responses
200
Updated endpoint
application/json
500
Failed to update the endpoint
put
PUT /api/endpoints/{id}/operation HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "operation": "enable"
}
{
  "id": "text",
  "currentState": "enabling",
  "targetState": "enabled",
  "connectionId": "text",
  "operation": "text",
  "address": {},
  "agentName": "text"
}

Update an existing mapping

put
Body
operationstring · enumRequiredPossible values:
Responses
200
Updated mapping
application/json
500
Failed to update the mapping
put
PUT /api/mappings/{id}/operation HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "operation": "enable"
}
{
  "id": "text",
  "currentState": "enabling",
  "targetState": "enabled",
  "mappings": [
    {}
  ],
  "agentName": "text"
}

Update an existing servers

put
Body
operationstring · enumRequiredPossible values:
Responses
200
Updated server
application/json
500
Failed to update the server
put
PUT /api/servers/{id}/operation HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "operation": "enable"
}
{
  "id": "text",
  "options": {},
  "currentState": "enabling",
  "targetState": "enabled",
  "protocol": "Opcua",
  "agentName": "text"
}

Execute rule engine transformation

post
Body
inputobject | array | string | null | number | booleanRequired

The body being inputted for transformation

transformationstringRequired

The transformation expression

Responses
200
Transformed output
application/json
Responseobject
500
Failed to transform input
post
POST /api/rule-engine/transform HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "input": null,
  "transformation": "text"
}
{}