Modify Bridge Configuration

Change connection details and TCP tunnel creation thresholds for an existing bridge. After successful update, the bridge is active with new settings. For more information, see Manage Bridges.

You can submit a shorter payload with the full path of the modified key-value pair, for example: {"jobs": {"tunnel_creation": {"interval_minutes": 10}}}.

Security: Requires Platform Admin privileges.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the Bridge

Body Params

Full payload with all legal fields for modifying bridge configuration. You can submit a shorter payload with the full path of the modified key-value pair.

string

A new pairing token to update the bridge trust relationship

remote
object
local
object
integer

Minimum number of tunnels

integer

Maximum number of tunnels

target_usage
object
jobs
object
Responses
204

Success - Bridge configuration updated

400

Bad Request - Failed to update bridge

401

Unauthorized user

403

Action not permitted for this account

404

Specified bridge not found

500

Internal Server Error

Language
Credentials
Bearer
JWT
URL
LoadingLoading…