Skip to main content
GET
Relay bridge status

Authorizations

apikey
string
header
required

Path Parameters

bridge_id
string
required

The bridge identifier to look up - the same value the bridge registered with and that your runs name in target.metadata.relay.bridge_id.

Example:

"customer-bridge-1"

Response

200 - application/json

Successful Response

bridge_id
string
required

The bridge id that was looked up, echoed back.

Example:

"customer-bridge-1"

connected
boolean
required

Whether a bridge with this id, registered under your account, currently holds a live connection. false also covers "no such bridge" and "a bridge by that name exists but belongs to someone else" - the two are not distinguished on purpose.

Example:

true