Skip to main content

Get a data stream bridge

GET 
/api/v1/orgs/{orgId}/data-bridges/{bridgeId}

Return the full bridge definition. The response mirrors the request shape with mqtt, assemblyPolicy, bindings, and runtimeState sections.

The runtimeState section reports the current runtime snapshot:

  • status: one of Stopped, Starting, Running, Faulted, Stopping.
  • lastPublishTime: timestamp of the last published payload, or null if nothing has been published.
  • queueDepth: number of items currently buffered in memory.
  • fault: fault details, present only when status is Faulted; null otherwise.

fault.code is one of:

  • BROKER_NOT_FOUND: the MQTT broker configuration was missing at worker startup.
  • CREDENTIALS_NOT_FOUND: stored broker credentials were missing at worker startup.
  • BROKER_CONNECTION_FAILED: the worker could not connect to the broker.
  • NATS_SUBSCRIPTION_FAILED: the NATS subscription could not be established.
  • BRIDGE_NOT_FOUND: the bridge record was missing at worker startup.
  • RUNTIME_STATE_NOT_FOUND: the runtime state record was missing at worker startup.
  • INTERNAL_ERROR: an unexpected error outside the categories above.
  • TLS_INVALID_CA_CERT: the broker certificate does not chain to the CA referenced by tls.caCertificateId, or that certificate no longer exists.
  • TLS_EXPIRED_CA_CERT: a certificate in the broker's chain has expired or is not yet valid.
  • TLS_HOSTNAME_MISMATCH: the broker certificate does not cover the host in brokerEndpoint.
  • TLS_UNSUPPORTED_VERSION: reserved. TLS 1.2 is the minimum offered, and a broker that supports nothing above TLS 1.1 aborts before presenting a certificate, so such a failure currently reports BROKER_CONNECTION_FAILED.

fault.willRetry reports whether an automatic restart is still pending; fault.maxRetryAttempts is the cap after which a manual restart is required.

Request​

Responses​

OK