PUT /v1/admin/gateway-settings
Replace both lists (Gateways pick them up within a minute; audited)
- operationId
updateAgentGatewaySettings- Auth
- Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
- Required permissions
The contract has no separate permission annotation; see the description below and the 403 response.
Description (from the contract)
Optimistic concurrency without a stored revision. If-Match must equal the ETag of the current settings (compared under the table lock); otherwise nothing is written and 409 gateway_settings_changed tells the page to reload.
Parameters
updateAgentGatewaySettings Parameters| Name | In | Type | Required | Description |
|---|
If-Match | header | string | Yes | ETag returned by the GET (or the previous PUT) the form was loaded from. |
|---|
Request body
application/json · Required：Yes
updateAgentGatewaySettings Request body| Name | Type | Required | Description |
|---|
trusted_proxies | array<object> | Yes | Trusted CDN back-to-origin ranges. Only Cloudflare is preset (CF-Connecting-IP); an empty header binds X-Forwarded-For. |
|---|
entrypoints | array<object> | Yes | Extra node entry points listed after the online Gateways, e.g. a CDN's 443 with transport ws. |
|---|
Responses
updateAgentGatewaySettings Responses| Status | Description |
|---|
200 | Saved (normalized). ETag is the digest of the saved settings. Fields：trusted_proxies: array<object> entrypoints: array<object> |
|---|
409 | gateway_settings_changed (someone else saved since the form was loaded; reload and retry) |
|---|
422 | invalid_input |
|---|
428 | precondition_required (If-Match missing or repeated) |
|---|
What to do on failure
409 Read the current state first; a retry of the same operation keeps the original Idempotency-Key and body.428 A precondition is missing: read the resource and send If-Match (or the required proof).
↑ Back to list