Skip to main content
GET
/
backends
/
weighted
/
{id}
Get
curl --request GET \
  --url https://api.ngrok.com/backends/weighted/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'ngrok-version: <ngrok-version>'
{
  "id": "<string>",
  "uri": "<string>",
  "created_at": "<string>",
  "description": "<string>",
  "metadata": "<string>",
  "backends": {}
}

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

a resource identifier

Response

200 - application/json

Get detailed information about a Weighted backend by ID

​
id
string

unique identifier for this Weighted backend

​
uri
string

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

​
backends
object

the ids of the child backends to their weights [0-10000]