COconductorone
Tunnel

Update Bridge

Changed on

UpdateBridge patches a bridge's editable metadata (display_name, description). Credentials are not affected.

patch/api/v1/iam/tunnel/bridges/{id}

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/iam/tunnel/bridges/{id}
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Path parameters

idstring required

The id field.

Request body

descriptionstring

New description. Applied only when "description" is in update_mask. Empty clears the description.

displayNamestring

New display name. Applied only when "display_name" is in update_mask. Must be non-empty when applied.

updateMaskstring nullable

Response

Successful response

Changes