Skip to main content
PATCH
/
backends
/
tunnel_group
/
{id}
Update
curl --request PATCH \
  --url https://api.ngrok.com/backends/tunnel_group/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'ngrok-version: <ngrok-version>' \
  --data '
{
  "id": "<string>",
  "description": "<string>",
  "metadata": "<string>",
  "labels": {}
}
'
{
  "id": "<string>",
  "uri": "<string>",
  "created_at": "<string>",
  "description": "<string>",
  "metadata": "<string>",
  "labels": {},
  "tunnels": [
    {
      "id": "<string>",
      "uri": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://ngrok.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

Path Parameters

​
id
string
required

Body

application/json
​
id
string

n/a

​
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

200 - application/json

Update TunnelGroup backend by ID

​
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