Update Bridge

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

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

Typescript (SDK)

TypeScript

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.tunnelCredentials.updateBridge({
    id: "<id>",
  });

  console.log(result);
}

run();

curl --request PATCH \
  --url https://{tenantDomain}.conductor.one/api/v1/iam/tunnel/bridges/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "displayName": "<string>",
  "updateMask": "<string>"
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/iam/tunnel/bridges/{id}"

payload = {
    "description": "<string>",
    "displayName": "<string>",
    "updateMask": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({description: '<string>', displayName: '<string>', updateMask: '<string>'})
};

fetch('https://{tenantDomain}.conductor.one/api/v1/iam/tunnel/bridges/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}.conductor.one/api/v1/iam/tunnel/bridges/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'displayName' => '<string>',
    'updateMask' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}.conductor.one/api/v1/iam/tunnel/bridges/{id}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"updateMask\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}.conductor.one/api/v1/iam/tunnel/bridges/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"updateMask\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/iam/tunnel/bridges/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"updateMask\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "bridge": {
    "appliance": {
      "announcedServiceCount": 123,
      "lastSeenAt": "2023-11-07T05:31:56Z",
      "links": [
        {
          "avgRtt": "<string>",
          "leaseExpiresAt": "2023-11-07T05:31:56Z",
          "relayAddress": "<string>",
          "relayId": "<string>"
        }
      ]
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "displayName": "<string>",
    "id": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

id · string · required

The id field.

Body

application/json

The TunnelCredentialsServiceUpdateBridgeRequest message.

description · string | null

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

displayName · string | null

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

updateMask · string | null

Response

200 - application/json

Successful response

The TunnelCredentialsServiceUpdateBridgeResponse message.

bridge · Tunnel Bridge · object | null

TunnelBridge is the API view of a bridge — the customer-facing entity for managing a wormhole tunnel appliance.

Show child attributes