Skip to main content
POST
/
backends
/
tunnel_group
Create
curl --request POST \
  --url https://api.ngrok.com/backends/tunnel_group \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'ngrok-version: <ngrok-version>' \
  --data '
{
  "description": "<string>",
  "metadata": "<string>",
  "labels": {}
}
'
import requests

url = "https://api.ngrok.com/backends/tunnel_group"

payload = {
"description": "<string>",
"metadata": "<string>",
"labels": {}
}
headers = {
"ngrok-version": "<ngrok-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {
'ngrok-version': '<ngrok-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({description: '<string>', metadata: '<string>', labels: {}})
};

fetch('https://api.ngrok.com/backends/tunnel_group', 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://api.ngrok.com/backends/tunnel_group",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'metadata' => '<string>',
'labels' => [

]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"ngrok-version: <ngrok-version>"
],
]);

$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://api.ngrok.com/backends/tunnel_group"

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

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

req.Header.Add("ngrok-version", "<ngrok-version>")
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.post("https://api.ngrok.com/backends/tunnel_group")
.header("ngrok-version", "<ngrok-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"metadata\": \"<string>\",\n \"labels\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.ngrok.com/backends/tunnel_group")

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

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

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "uri": "<string>",
  "created_at": "<string>",
  "description": "<string>",
  "metadata": "<string>",
  "labels": {},
  "tunnels": [
    {
      "id": "<string>",
      "uri": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Headers

ngrok-version
integer
default:2
required

Body

application/json
description
string

human-readable description of this backend. Optional

metadata
string

arbitrary user-defined machine-readable data of this backend. Optional

labels
object

labels to watch for tunnels on, e.g. app->foo, dc->bar

Response

201 - application/json

Create a new TunnelGroup backend

id
string

unique identifier for this TunnelGroup backend

uri
string

URI of the TunnelGroupBackend API resource

created_at
string

timestamp when the backend was created, RFC 3339 format

description
string

human-readable description of this backend. Optional

metadata
string

arbitrary user-defined machine-readable data of this backend. Optional

labels
object

labels to watch for tunnels on, e.g. app->foo, dc->bar

tunnels
object[]

tunnels matching this backend