---
title: "Update"
method: PATCH
path: "/backends/tunnel_group/{id}"
tags: ["TunnelGroupBackends"]
---

# Update

`PATCH /backends/tunnel_group/{id}`

Update TunnelGroup backend by ID

## Path parameters

- `id` string, required

## Headers

- `ngrok-version` integer, required

## Request body

- TunnelGroupBackendUpdate
  - `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`

Update TunnelGroup backend by ID

- TunnelGroupBackend
  - `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` Ref[] — tunnels matching this backend
    - `id` string — a resource identifier
    - `uri` string — a uri for locating a resource

---

[API](https://skmtc.net/ngrok/apis/ngrok-openapi.md) · [All operations](https://skmtc.net/ngrok/apis/ngrok-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ngrok/ngrok-openapi/versions/1994bbb04714/schema)