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

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

address
string

the address to forward to

tls
object

tls configuration to use

Response

200 - application/json

Update static backend by ID

id
string

unique identifier for this static backend

uri
string

URI of the StaticBackend 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

address
string

the address to forward to

tls
object

tls configuration to use