Skip to main content

list upstreams

GET /api/upstreams lists all the upstreams available on the server

Required scope: upstreams:manage:all

Responses
200
Schema — OPTIONAL
object[]
authorize boolean
host string
pool_size int32
port string
required_scopes object
GET string[]
scheme string
strip_uri boolean
noise_cancelling_enabled boolean — OPTIONAL

Enables request noise detection for this upstream. An OpenAPI specification must be supplied when enabling it without an existing trained model.

noise_cancelling_configured boolean — OPTIONAL

Indicates whether a trained noise-cancelling model is configured for this upstream.

openapi_spec string — OPTIONAL

An OpenAPI document in JSON or YAML format used to train the noise-cancelling model. The document is not persisted or returned.

uris string[]
401

The client is unauthorized to access this resource.

Schema — OPTIONAL
code string
message string
403

The client is forbidden to access this resource.

Schema — OPTIONAL
code string
message string