LogoLogo
Contact Uscybus.io
Connectware 1.11.0
Connectware 1.11.0
  • 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
      • Restarting Connectware
    • 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
      • Deviations
      • 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
      • Certificates View
      • Adding Certificates
      • Removing Certificates
    • Monitoring
      • Data Explorer
      • Live Data
    • Node-RED Workbench
    • System Status
      • Info
      • Metrics
      • Status
      • Retrieving More System Information
      • System Health
    • Backup and Restore
      • Volumes
      • User Database
    • CybusMQ
      • Configuring CybusMQ
    • 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 Endpoint Properties
    • API Reference
      • User Management (API)
      • Client Registry (API)
      • Services (API)
      • Resources (API)
      • System Status (API)
      • Resource Status Tracking (HTTP API)
      • Industry Protocol Details (API)
    • Changelog
Powered by GitBook
LogoLogo

Cybus

  • Terms and Condition
  • Imprint
  • Data Privacy

© Copyright 2025, Cybus GmbH

On this page
  • Commissioning File Specifics
  • Sending data to the HTTP Server
  • Receiving data from the HTTP Server
  • Service Commissioning File Example

Was this helpful?

  1. Documentation
  2. Industry Protocol Details

HTTP Server/Node

PreviousHTTP/REST Endpoint PropertiesNextHTTP Server Properties

Last updated 2 months ago

Was this helpful?

The HTTP Server resource offers access to data points through a HTTP/REST interface.

  • This server will accept JSON data via POST or PUT and forwarding that data to corresponding MQTT topic.

  • User access and authentication can be configured using the existing connectware functionalities for HTTP permissions.

  • The listening port is the same port 443 which is also used for HTTPS access to the other REST interfaces of the Connectware, where each request with the path /data refers to the internal HTTP server for data access.

The HTTP server can be configured using the Cybus::Server::Http resource. The server resource defines an optional base path prefix in addition to the standard /data prefix.

Each HTTP route is described by a Cybus::Node::Http resource that defines the path and http method as parameters to specify the route.

Permissions

User access and authentication can be configured using the existing connectware functionalities for HTTP permissions, see and . For the example below where the user should PUT or POST to the route data/cybustest/postRoute, the user must be granted matching write permissions, e.g. data/cybustest/# or data/+/postRoute.

Commissioning File Specifics

Sending data to the HTTP Server

JSON

If the server receives a messages with the header Content-type=application/json, it will parse the HTTP message body in JSON format, then transform the content into the internal message convention where the message body is in the value property. Example:

// Original message sent to HTTP server
{
  "machineState": "okay",
  "temperature": 23,
  "logs": [
    "message1",
    "message2"
  ]
}

// Resulting protocol-mapper output at the MQTT broker
{
   "timestamp": 12391238123, // milliseconds since epoch
   "value": {
      "machineState": "okay",
      "temperature": 23,
      "logs": [
        "message1",
        "message2"
      ]
    }
}

If the request sent to the server is not parseable as JSON, it will be dropped and not forwarded to the MQTT broker.

Other Formats

Other supported mime-types in the Content-type header are:

  • application/octet-stream

  • text/plain

  • text/xml

  • text/csv

In all of these cases, the HTTP message body is forwarded to the specified topic without any further modification (no timestamp, no value property).

Receiving data from the HTTP Server

JSON

Each Node with method = GET has an internal cache, which will store any date written to it using the */write topic. The cache has a depth of 1, so only the latest data is being stored.

Data will always be in the format of a JSON object containing value and timestamp. If no timestamp is provided, one will be generated.

If no data is available, the server will respond with status of 204.

// Original message sent to MQTT broker
{
  "value": "Cybus"
}

// Resulting protocol-mapper output at the MQTT broker
{
   "timestamp": 12391238123, // milliseconds since epoch
   "value": "Cybus"
}

Service Commissioning File Example

The endpoints from the commissioning file can be accessed using the following curl commands. It is assumed that the Connectware is configured so that the data route is accessible by basic auth authentication, and that the user has sufficient HTTP permission to write to the path data/cybustest/postRoute.

The POST based demo endpoint:

curl --location --request POST 'https://my.connectwareurl.com/data/cybustest/postRoute' \
--header 'Authorization: Basic <BASIC AUTH TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "test1": "testdata send via POST Route"
}'

The PUT based demo endpoint:

curl --location --request PUT 'https://my.connectwareurl.com/data/cybustest/putRoute' \
--header 'Authorization: Basic <BASIC AUTH TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "test2": "testdata send via PUT Route"
}'

The GET based demo endpoint:

curl --location --request GET 'https://my.connectwareurl.com/data/cybustest/getRoute' \
--header 'Authorization: Basic <BASIC AUTH TOKEN>'
http-server-example.yml
---
description: Provides a demonstration structure for a http server configured in the protocol mapper

metadata:
    name: Definition By Example for HTTP Endpoints

parameters: {}

resources:
    httpServer:
        type: Cybus::Server::Http
        properties:
            basePath: /cybustest

    postRoute:
        type: Cybus::Node::Http
        properties:
            parent: !ref httpServer
            method: POST
            route: /postRoute

    putRoute:
        type: Cybus::Node::Http
        properties:
            parent: !ref httpServer
            method: PUT
            route: /putRoute

    getRoute:
        type: Cybus::Node::Http
        properties:
            parent: !ref httpServer
            method: GET
            route: /getRoute

    httpMapping:
        type: Cybus::Mapping
        properties:
            mappings:
                - subscribe:
                      endpoint: !ref postRoute
                  publish:
                      topic: output/postroute
                - subscribe:
                      endpoint: !ref putRoute
                  publish:
                      topic: output/putroute
                - subscribe:
                      topic: input/getRoute
                  publish:
                      endpoint: !ref getRoute
Roles
Permissions
Custom Server Properties
Custom Node Properties
1KB
http-server-example.yml