Modify Bridge Configuration

JFrog REST APIs

Content Type
REST API

Description: Change connection details and TCP tunnel creation thresholds for an existing bridge. After successful update, the bridge is active with new settings.

Related Documentation: Use this API to modify Bridge Advanced Parameters..You can Manage JFrog Bridges in the JFrog Platform interface.Bridge Advanced ParametersManage JFrog Bridges

Security: Requires a valid admin tokenGenerate a Token in MyJFrog

Usage:

PATCH https://{{bridge_client_BaseURL}}/bridge-client/api/v1/bridges/{{bridge_ID}} 

where

{{bridge_client_BaseURL}} is the URL of the JPD that is the Bridge Client.

{{bridge_ID}} is the unique identifier of the Bridge.

Request payload::

The following sample lists the full payload with all legal fields:

{
  "remote": {
    "url": "string_value",
    "insecure": true,
    "proxy": {
      "enabled": true,
      "cache_expiration_secs": 300,
      "key": "string_value",
      "scheme_override": "http"
    }
  },
  "local": {
    "url": "string_value",
    "anonymous_endpoints": [
      "endpoint1",
      "endpoint2"
    ]
  },
  "min_tunnels": 1,
  "max_tunnels": 5,
  "target_usage": {
    "low": 10,
    "high": 100
  },
  "jobs": {
    "tunnel_creation": {
      "interval_minutes": 10
    },
    "tunnel_closing": {
      "cron_expr": "0 0 * * *",
      "allow_close_used_tunnels": false
    }
  }
}

You can submit a shorter payload with the full path of the modified key-value pair, as in the example below:

{"jobs":{"tunnel_creation":{"interval_minutes": 10}}}

Content-Type: application/json

Produces: application/json

Response status codes:

204- Success

400- Failed

401- Unauthorized user

403- Action not permitted for this account