UniteLabs
How-to

Connect to Platform

Server-initiated connection — this page explains what it enables and how to turn it on with a single setting.

GroundControl and connectors work entirely locally without an internet connection. The server-initiated connection (Cloud connectivity) is what makes connectors accessible from the UniteLabs Platform, the UniteLabs SDK, and the REST API — from anywhere, not just the local network.

What Platform connectivity enables

Without Platform connectionWith Platform connection
Connectors are reachable only from the local networkConnectors are reachable from the UniteLabs Platform and SDK from anywhere
Connector interface available, but cannot be used with UniteLabs SDKs. No workflow executionWorkflows written with the UniteLabs SDK can connect to the connectors. enables workflow execution
No visibility in the Platform UIConnectors appear in the Platform Connectors page

If you want to use the UniteLabs Platform, build workflows, or access instruments remotely, enable it.

We are working towards making more Platform features available via GroundControl, e.g. hybrid execution.

How it works

The connector's SiLA 2 API is relayed to your tenant over one outbound TLS connection. The lab starts the connection, not the cloud, so no inbound ports are required. Network requirements lists the host and port your firewall has to allow.

In the current state, each connector initiates a connection to the Platform API endpoint and communication is not yet channeled through GroundControl.

Enable cloud connectivity

You turn it on during the initial configuration of GroundControl: the Tenant ID and the Default Cloud Server URL in Settings prefill the cloud endpoint for your connectors. To set the endpoint for a single connector instead, use its Cloud Connectivity section.

For connectors run as standalone executables (without GroundControl), add the cloud endpoint to the connector's config.json:

{
  "cloud_server_endpoint": {
    "hostname": "<tenant-id>.unitelabs.io",
    "port": 443,
    "tls": true
  }
}

See Headless install for the full setup flow.

Verify the connection

Once GroundControl is signed in and your connectors are running, open the UniteLabs Platform. Your connectors should appear as online within a few seconds.

If a connector shows as offline:

  • Confirm the connector process is running in GroundControl
  • Confirm you can call the connector from its Operations tab in GroundControl
  • Review the Activity tab in GroundControl for error messages
  • Check the connector logs and confirm your network allows the outbound connection described in Network requirements
  • Verify the TLS setting and contact your network administrator about potential requirements for certificates.

Last updated