Upstream
Update Upstream
Getting Started
- Overview
- Installation & Running
- Quickstart: Hello Gateway
- Tutorials & Guides
Core Concepts
Traffic Management
- Rules & Forwarding
- Load Balancing
Rate Limiting & Request Control
- Rate Limiting
- Request Size Limiting
Content Security
- Overview
- NeuralTrust Guardrail
- Contextual Security
- Prompt Jailbreaks Protection
- Toxicity Detection
- Content Moderation
Application Security
Extending Functionality
Observability & Monitoring
- Prometheus
- Metric Exporters
API Reference
- Gateway
- API Key
- Upstream
- Service
- Rule
Upstream
Update Upstream
Updates an existing upstream
PUT
/
api
/
v1
/
gateways
/
{gateway_id}
/
upstreams
/
{upstream_id}
{
"algorithm": "<string>",
"created_at": "<string>",
"gateway_id": "<string>",
"health_checks": {
"headers": {},
"interval": 123,
"passive": true,
"path": "<string>",
"threshold": 123
},
"id": "<string>",
"name": "<string>",
"tags": [
"<string>"
],
"targets": [
{
"credentials": {
"allow_override": true,
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>",
"azure_client_id": "<string>",
"azure_client_secret": "<string>",
"azure_tenant_id": "<string>",
"azure_use_managed_identity": true,
"gcp_service_account_json": "<string>",
"gcp_use_service_account": true,
"header_name": "<string>",
"header_value": "<string>",
"param_location": "<string>",
"param_name": "<string>",
"param_value": "<string>"
},
"default_model": "<string>",
"headers": {},
"host": "<string>",
"id": "<string>",
"models": [
"<string>"
],
"path": "<string>",
"port": 123,
"priority": 123,
"protocol": "<string>",
"provider": "<string>",
"tags": [
"<string>"
],
"weight": 123
}
],
"updated_at": "<string>"
}
Body
application/json
Updated upstream data
General settings
AWS auth
Azure auth
GCP auth
Header-based auth
"query" or "body"
Parameter-based auth
Response
200 - application/json
Upstream updated successfully
General settings
AWS auth
Azure auth
GCP auth
Header-based auth
"query" or "body"
Parameter-based auth
{
"algorithm": "<string>",
"created_at": "<string>",
"gateway_id": "<string>",
"health_checks": {
"headers": {},
"interval": 123,
"passive": true,
"path": "<string>",
"threshold": 123
},
"id": "<string>",
"name": "<string>",
"tags": [
"<string>"
],
"targets": [
{
"credentials": {
"allow_override": true,
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>",
"azure_client_id": "<string>",
"azure_client_secret": "<string>",
"azure_tenant_id": "<string>",
"azure_use_managed_identity": true,
"gcp_service_account_json": "<string>",
"gcp_use_service_account": true,
"header_name": "<string>",
"header_value": "<string>",
"param_location": "<string>",
"param_name": "<string>",
"param_value": "<string>"
},
"default_model": "<string>",
"headers": {},
"host": "<string>",
"id": "<string>",
"models": [
"<string>"
],
"path": "<string>",
"port": 123,
"priority": 123,
"protocol": "<string>",
"provider": "<string>",
"tags": [
"<string>"
],
"weight": 123
}
],
"updated_at": "<string>"
}