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

Services (API)

PreviousClient Registry (API)NextResources (API)

Last updated 23 days ago

Was this helpful?

17KB
Service Manager Schema.yaml

Read all services

get
Authorizations
Responses
200
Array of services
application/json
get
GET /api/services HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

Array of services

[
  {
    "id": "text",
    "commissioningData": {},
    "resources": {},
    "targetState": "text",
    "currentState": "text"
  }
]

Get status of all services

get
Authorizations
Responses
200
Map of service statuses
application/json
Responseobject
get
GET /api/services/status HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

Map of service statuses

{}

Get information of all services

get
Authorizations
Responses
200
Map of service information
application/json
Responseobject
get
GET /api/services/info HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

Map of service information

{}

Get the instance names of the services

get
Authorizations
Responses
200
Map of service information
application/json
Responsestring[]
get
GET /api/services/instances HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

Map of service information

[
  "text"
]

Get a specific service

get
Authorizations
Path parameters
idstringRequired

Id of service

Responses
200
Service
application/json
400
Invalid request
404
Service not found
get
GET /api/services/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
{
  "id": "text",
  "commissioningData": {},
  "resources": {},
  "targetState": "text",
  "currentState": "text"
}

Delete an existing service

delete
Authorizations
Path parameters
idstringRequired

Id of service

Responses
200
OK
application/json
404
Service not found
delete
DELETE /api/services/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
{
  "id": "text"
}

Get a specific service status

get
Authorizations
Path parameters
idstringRequired

Id of service

Responses
200
Service
application/json
400
Invalid request
404
Service not found
get
GET /api/services/{id}/status HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
{
  "id": "text",
  "targetState": "text",
  "currentState": "text"
}

Get the service dependencies

get
Authorizations
Path parameters
idstringRequired

Id of service

Responses
200
Service dependencies
application/json
400
Invalid request
404
Service not found
get
GET /api/services/{id}/dependencies HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
{
  "dependent": [
    "text"
  ],
  "dependsOn": [
    "text"
  ]
}

Get all ingress routes

get
Authorizations
Responses
200
Ingress routes
application/json
400
Invalid request
get
GET /api/services/ingress-routes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
[
  {
    "id": "text",
    "containerHost": "text",
    "containerPort": 1,
    "containerPrefixRewrite": "text",
    "ingressPort": 1,
    "ingressUrlPrefix": "text",
    "type": "text",
    "headers": [
      "text"
    ]
  }
]

Get all Cybus::Link routes

get
Authorizations
Responses
200
Links
application/json
400
Invalid request
get
GET /api/services/links HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
[
  {
    "id": "text",
    "ingressRoute": "text",
    "name": "text",
    "href": "text"
  }
]

Get all links by all services

get
Authorizations
Responses
200
Links
application/json
400
Invalid request
get
GET /api/services/all-links HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
[
  {
    "id": "text",
    "name": "text",
    "links": []
  }
]

Get all of the resource schemas

get
Authorizations
Responses
200
Resource schemas in a JSON string
application/json
400
Invalid request
500
Internal error
get
GET /api/resources/schemas HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
{
  "[a-zA-Z0-9]+": {},
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
  • POSTvalidate a commissioning file
  • POSTCreate a new service
  • GETRead all services
  • POSTGet the service schemas
  • GETGet status of all services
  • GETGet information of all services
  • GETGet the instance names of the services
  • GETGet a specific service
  • PUTUpdate an existing service
  • DELETEDelete an existing service
  • GETGet a specific service status
  • GETGet the service dependencies
  • GETGet all ingress routes
  • GETGet all Cybus::Link routes
  • GETGet all links by all services
  • PUTPerform an operation on a service
  • GETGet all of the resource schemas

validate a commissioning file

post
Authorizations
Body
commissioningFilestringRequired

The commissioning file of this service as base64 encoded content of a buffer

Responses
200
Validation Successful
400
Validation Error
application/json
406
Invalid Content
application/json
post
POST /api/validate/service HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "commissioningFile": "text"
}

No content

Create a new service

post
Authorizations
Body
idstring · min: 4Required
commissioningFilestringRequired

The commissioning file of this service as base64 encoded content of a buffer

parametersobjectOptional

The parameter values of this service as a JSON object

marketplaceobjectOptional
targetStatestring · enumOptionalPossible values:
Responses
201
Created service
application/json
400
Validation Error
application/json
406
Invalid Content
application/json
post
POST /api/services HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "id": "text",
  "commissioningFile": "text",
  "parameters": {},
  "marketplace": {},
  "targetState": "disabled"
}
{
  "id": "text",
  "targetState": "text",
  "currentState": "text"
}

Get the service schemas

post
Authorizations
Body
commissioningFilestringRequired

The commissioning file of this service as base64 encoded content of a buffer

Responses
201
Service schemas
application/json
Responseobject
400
Validation Error
application/json
406
Invalid Content
application/json
post
POST /api/services/parametersSchema HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "commissioningFile": "text"
}
{}

Update an existing service

put
Authorizations
Path parameters
idstringRequired

Id of service

Body
parametersobjectOptional
commissioningFilestringOptional
marketplaceobjectOptional
Responses
202
Accepted
400
Validation Error
application/json
406
Invalid Content
application/json
put
PUT /api/services/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "parameters": {},
  "commissioningFile": "text",
  "marketplace": {}
}

No content

Perform an operation on a service

put
Authorizations
Path parameters
idstringRequired

Id of service

Body
operationstringOptional

Disable and enable

Responses
200
Service
application/json
400
Invalid request
404
Service not found
put
PUT /api/services/{id}/operation HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "operation": "text"
}
{
  "id": "text",
  "targetState": "text",
  "currentState": "text"
}