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

Resources (API)

PreviousServices (API)NextSystem Status (API)

Last updated 23 days ago

Was this helpful?

13KB
Container Manager Schema.yaml

Get all service containers

get
Responses
200
All service containers
application/json
Responseobject[]
404
Failed to get all service containers
get
GET /api/containers HTTP/1.1
Host: 
Accept: */*
[
  {}
]

Inspect service container

get
Responses
200
Service container inspect
application/json
Responseobject
404
Failed to inspect service container
get
GET /api/containers/{name}/inspect HTTP/1.1
Host: 
Accept: */*
{}

Get service container logs

get
Path parameters
namestringRequired

Name of the service container

Query parameters
timestampsstring · enumOptional

If the logs should yield timestamp

Possible values:
tailstringOptional

Use 'all' to retrieve all, or a number for a limited set

sincestringOptional

Timestamp for the start

untilstringOptional

Timestamp for the end

Responses
200
Service container logs
application/json
Responsestring
404
Failed to get container logs
get
GET /api/containers/{name}/logs HTTP/1.1
Host: 
Accept: */*
text

Get container state

get
Responses
200
Service container state
application/json
Responseobject
404
Failed to get service container state
get
GET /api/containers/{name}/state HTTP/1.1
Host: 
Accept: */*
{}

Returns info about orchestrator being used to run Connectware

get
Responses
200
Returns the name of the orchestrator being used to run Connectware
application/json
get
GET /api/containers/orchestrator HTTP/1.1
Host: 
Accept: */*
200

Returns the name of the orchestrator being used to run Connectware

{
  "orchestrator": "Docker"
}

Get all core containers

get
Responses
200
All core containers
application/json
Responseobject[]
404
Failed to get all core containers
get
GET /api/core-containers HTTP/1.1
Host: 
Accept: */*
[
  {}
]

Inspect core container

get
Responses
200
Core container inspect
application/json
Responseobject
404
Failed to inspect core container
get
GET /api/core-containers/{name}/inspect HTTP/1.1
Host: 
Accept: */*
{}

Get core container logs

get
Path parameters
namestringRequired

Name of the core container

Query parameters
timestampsstring · enumOptional

If the logs should yield timestamp

Possible values:
tailstringOptional

Use 'all' to retrieve all, or a number for a limited set

sincestringOptional

Timestamp for the start

untilstringOptional

Timestamp for the end

Responses
200
Core container logs
application/json
Responsestring
404
Failed to get core container logs
get
GET /api/core-containers/{name}/logs HTTP/1.1
Host: 
Accept: */*
text

Get core container state

get
Responses
200
Core Container state
application/json
Responseobject
404
Failed to get core container state
get
GET /api/core-containers/{name}/state HTTP/1.1
Host: 
Accept: */*
{}

Returns info about orchestrator being used to run Connectware

get
Responses
200
Returns the name of the orchestrator being used to run Connectware
application/json
get
GET /api/core-containers/orchestrator HTTP/1.1
Host: 
Accept: */*
200

Returns the name of the orchestrator being used to run Connectware

{
  "orchestrator": "Docker"
}

Get all images

get
Responses
200
All images
application/json
Responseobject[]
404
Failed to get all images
get
GET /api/images HTTP/1.1
Host: 
Accept: */*
[
  {}
]

Inspect a image

get
Responses
200
Image inspect
application/json
Responseobject
404
Failed to inspect image
get
GET /api/images/{name}/inspect HTTP/1.1
Host: 
Accept: */*
{}

Get all networks

get
Responses
200
All networks
application/json
Responseobject[]
404
Failed to get all networks
get
GET /api/networks HTTP/1.1
Host: 
Accept: */*
[
  {}
]

Inspect a network

get
Responses
200
Network inspect
application/json
Responseobject
404
Failed to inspect network
get
GET /api/networks/{name}/inspect HTTP/1.1
Host: 
Accept: */*
{}

Get all volumes

get
Responses
200
All volumes
application/json
Responseobject[]
404
Failed to get all volumes
get
GET /api/volumes HTTP/1.1
Host: 
Accept: */*
[
  {}
]

Inspect a volume

get
Responses
200
Volume inspect
application/json
Responseobject
404
Failed to inspect volume
get
GET /api/volumes/{name}/inspect HTTP/1.1
Host: 
Accept: */*
{}
  • GETGet all service containers
  • GETInspect service container
  • GETGet service container logs
  • GETGet container state
  • GETReturns info about orchestrator being used to run Connectware
  • PUTPerform an operation on a service container
  • GETGet all core containers
  • GETInspect core container
  • GETGet core container logs
  • GETGet core container state
  • GETReturns info about orchestrator being used to run Connectware
  • PUTPerform an operation on a core container
  • GETGet all images
  • GETInspect a image
  • GETGet all networks
  • GETInspect a network
  • GETGet all volumes
  • GETInspect a volume

Perform an operation on a service container

put
Path parameters
namestringRequired

Name of the service container

Body
operationstring · enumRequiredPossible values:
Responses
200
Service container inspection after operation is performed
application/json
Responseobject
400
Invalid request
404
Service container not found
put
PUT /api/containers/{name}/operation HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "operation": "start"
}
{}

Perform an operation on a core container

put
Path parameters
namestringRequired

Name of the core container

Body
operationstring · enumRequiredPossible values:
Responses
200
Core container inspection after operation is performed
application/json
Responseobject
400
Invalid request
404
Core container not found
put
PUT /api/core-containers/{name}/operation HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "operation": "start"
}
{}