---
updatedAt: 2026-04-05T19:47:05.000Z
agentTools:
  siteIndex: https://docs.jfrog.com/llms.txt
  projectIndex: https://docs.jfrog.com/administration/llms.txt
---

# Get Bridge Configuration

Retrieve the configuration of a specific bridge. The remote token is redacted in the response for security purposes.

**Security:** Requires Platform Admin privileges.


# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "JFrog Platform - Bridge API",
    "description": "Manage secure, encrypted connections between JFrog Platform Deployments (JPDs) in hybrid topologies. For more information, see [JFrog Bridge](https://docs.jfrog.com/administration/docs/manage-jfrog-bridges).\n\n**Note:** Bridges defined directly in `system.yaml` appear in the Bridges table but cannot be managed using the Platform interface or the Bridge APIs. Use only the JFrog Platform interface or the Bridge APIs to create and manage Bridges.\n\n**Authentication:** Access Tokens as bearer token in authorization header (`Authorization: Bearer <token>`).\n\n**Security:** Unless otherwise specified, all APIs require Platform Admin privileges.\n",
    "version": "1.0.0",
    "contact": {
      "name": "JFrog Support"
    }
  },
  "servers": [
    {
      "url": "https://{jfrog_url}",
      "description": "JFrog Platform Server",
      "variables": {
        "protocol": {
          "default": "https",
          "enum": [
            "http",
            "https"
          ]
        },
        "host": {
          "default": "demo.jfrog.io",
          "description": "JFrog Platform hostname"
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Bridge Client",
      "description": "Manage bridge connections, configurations, and diagnostics on the Self-managed JPD."
    }
  ],
  "security": [
    {
      "AdminBearerAuth": []
    }
  ],
  "paths": {
    "/bridge-client/api/v1/bridges/{bridge_id}/config": {
      "get": {
        "tags": [
          "Bridge Client"
        ],
        "summary": "Get Bridge Configuration",
        "description": "Retrieve the configuration of a specific bridge. The remote token is redacted in the response for security purposes.\n\n**Security:** Requires Platform Admin privileges.\n",
        "operationId": "getBridgeConfig",
        "parameters": [
          {
            "name": "bridge_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The unique identifier of the Bridge"
          }
        ],
        "responses": {
          "200": {
            "description": "Success - Bridge configuration returned",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BridgeConfigResponse"
                },
                "example": {
                  "type": "default",
                  "bridge_id": "my-bridge-01",
                  "stopped": false,
                  "last_updated_at": 1706745600000,
                  "remote": {
                    "url": "https://mycompany.jfrog.io",
                    "token": "<removed>",
                    "insecure": false,
                    "proxy": {
                      "enabled": false,
                      "cache_expiration_secs": 300,
                      "key": "",
                      "scheme_override": ""
                    }
                  },
                  "local": {
                    "url": "https://my-local-jpd.example.com",
                    "anonymous_endpoints": [
                      ".*/system/(ping|readiness|liveness)"
                    ],
                    "dial_timeout_secs": 30
                  },
                  "min_tunnels": 1,
                  "max_tunnels": 5,
                  "target_usage": {
                    "low": 10,
                    "high": 100
                  },
                  "jobs": {
                    "tunnel_creation": {
                      "interval_minutes": 10
                    },
                    "tunnel_closing": {
                      "cron_expr": "",
                      "allow_close_used_tunnels": false
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized user"
          },
          "403": {
            "description": "Action not permitted for this account"
          },
          "404": {
            "description": "Specified bridge not found"
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "AdminBearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Access Token with admin permissions as bearer token",
        "bearerFormat": "JWT"
      }
    },
    "schemas": {
      "BridgeConfigResponse": {
        "type": "object",
        "description": "Bridge configuration response (remote token is redacted)",
        "properties": {
          "type": {
            "type": "string",
            "description": "Tunnel type"
          },
          "bridge_id": {
            "type": "string",
            "description": "Bridge identifier"
          },
          "stopped": {
            "type": "boolean",
            "description": "Whether the bridge is stopped"
          },
          "last_updated_at": {
            "type": "integer",
            "format": "int64",
            "description": "Timestamp of last configuration update (Unix epoch)"
          },
          "remote": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string",
                "description": "Remote Bridge Server URL"
              },
              "token": {
                "type": "string",
                "description": "Remote token (redacted as \"<removed>\" for security)"
              },
              "insecure": {
                "type": "boolean",
                "description": "Allow insecure connections"
              },
              "proxy": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean"
                  },
                  "cache_expiration_secs": {
                    "type": "integer"
                  },
                  "key": {
                    "type": "string"
                  },
                  "scheme_override": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "local": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string",
                "description": "Local Bridge Client URL"
              },
              "anonymous_endpoints": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "dial_timeout_secs": {
                "type": "integer"
              }
            }
          },
          "min_tunnels": {
            "type": "integer"
          },
          "max_tunnels": {
            "type": "integer"
          },
          "target_usage": {
            "type": "object",
            "properties": {
              "low": {
                "type": "integer"
              },
              "high": {
                "type": "integer"
              }
            }
          },
          "jobs": {
            "type": "object",
            "properties": {
              "tunnel_creation": {
                "type": "object",
                "properties": {
                  "interval_minutes": {
                    "type": "integer"
                  }
                }
              },
              "tunnel_closing": {
                "type": "object",
                "properties": {
                  "cron_expr": {
                    "type": "string"
                  },
                  "allow_close_used_tunnels": {
                    "type": "boolean"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false
  }
}
```