Skip to main content

Update a upstream

PUT /api/upstreams/:upstream_id updates the identified upstream resource

Required scope: upstreams:manage:all

Path Parameters
upstream_id string — REQUIRED
Request Body — REQUIRED
upstream object
authorize boolean — REQUIRED
host string — REQUIRED
pool_size int32 — REQUIRED
port string — REQUIRED
required_scopes object — REQUIRED
GET string[] — REQUIRED
scheme string — REQUIRED
strip_uri boolean — REQUIRED
noise_cancelling_enabled boolean

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

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

openapi_spec string

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

uris string[] — REQUIRED
Responses
200
Schema — OPTIONAL
data object — OPTIONAL
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[]
400

Bad request.

Schema — OPTIONAL
errors object — OPTIONAL
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
404

The requested resource could not be found.

Schema — OPTIONAL
code string
message string
422

The request payload is invalid.

Schema — OPTIONAL
errors object — OPTIONAL