Update tunnel configuration

Apply a new tunnel configuration on the fly. The existing tunnel is torn down and a new one is established. This endpoint is write-only; there is no corresponding GET to read the config back.

PUT /network/tunnel/config

Update tunnel configuration

cURL

curl --request PUT \
  --url https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/network/tunnel/config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": "eyJsb2NhbF9pcCI6ICIxMC4wLjAuMS8zMiIsIC4uLn0="
}
'

import requests

url = "https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/network/tunnel/config"

payload = { "config": "eyJsb2NhbF9pcCI6ICIxMC4wLjAuMS8zMiIsIC4uLn0=" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({config: 'eyJsb2NhbF9pcCI6ICIxMC4wLjAuMS8zMiIsIC4uLn0='})
};

fetch('https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/network/tunnel/config', 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://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/network/tunnel/config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'config' => 'eyJsb2NhbF9pcCI6ICIxMC4wLjAuMS8zMiIsIC4uLn0='
  ]),
  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://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/network/tunnel/config"

	payload := strings.NewReader("{\n  \"config\": \"eyJsb2NhbF9pcCI6ICIxMC4wLjAuMS8zMiIsIC4uLn0=\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/network/tunnel/config")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config\": \"eyJsb2NhbF9pcCI6ICIxMC4wLjAuMS8zMiIsIC4uLn0=\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/network/tunnel/config")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"config\": \"eyJsb2NhbF9pcCI6ICIxMC4wLjAuMS8zMiIsIC4uLn0=\"\n}"

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

200

{
  "message": "File created successfully",
  "path": "/path/to/file"
}

{
  "error": "Error message"
}

{
  "error": "Error message"
}

{
  "error": "Error message"
}

Authorizations

Authorization · string · header · required

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

Body

application/json

Base64-encoded tunnel configuration

config · string · required

Base64-encoded tunnel config JSON

Example:

"eyJsb2NhbF9pcCI6ICIxMC4wLjAuMS8zMiIsIC4uLn0="

Response

200

application/json

Configuration applied

message · string · required

Example:

"File created successfully"

path · string

Example:

"/path/to/file"