Set the deployment backend's health (the emergency kill switch)
The emergency control. healthy=false takes this deployment's backend out of routing entirely; the gateway excludes unhealthy backends from the live set. This is categorically stronger than weight 0, which keeps the backend as the standby/overflow tail and still routes to it exactly when the weighted backends are saturated or failing. healthy=true clears the kill. The setting survives restarts and reconcile passes until cleared.
Path parameters
Request body
Response
Updated
Changes
Changed in 5 of the 19 revisions of this API.120
- ○
added the optional property
maxUnavailableto the response with the200statusresponse-optional-property-added
- ○
added the optional property
rollingActiveto the response with the200statusresponse-optional-property-added
- ○
added the optional property
rolloutStrategyto the response with the200statusresponse-optional-property-added
- ○
- ○
added the optional property
autoscalePausedto the response with the200statusresponse-optional-property-added
- ○
- ●
added the new
pausedenum value to therollout/phaseresponse property for the response status200response-property-enum-value-added
- ○
added the optional property
changeCauseto the response with the200statusresponse-optional-property-added
- ○
added the optional property
generationto the response with the200statusresponse-optional-property-added
- ○
added the optional property
parentDeploymentIdto the response with the200statusresponse-optional-property-added
- ○
added the optional property
rollout/bluePoolPolicyto the response with the200statusresponse-optional-property-added
- ○
added the optional property
rollout/forceExpiredto the response with the200statusresponse-optional-property-added
- ○
added the optional property
rollout/forcedto the response with the200statusresponse-optional-property-added
- ○
added the optional property
rollout/forcedByto the response with the200statusresponse-optional-property-added
- ○
added the optional property
rollout/forcedReasonto the response with the200statusresponse-optional-property-added
- ○
added the optional property
rollout/greenPoolPolicyto the response with the200statusresponse-optional-property-added
- ○
added the optional property
rollout/pausedto the response with the200statusresponse-optional-property-added
- ○
added the optional property
rollout/policyMismatchto the response with the200statusresponse-optional-property-added
- ○
added the optional property
rolloutPausedto the response with the200statusresponse-optional-property-added
- ●
- ○
added the optional property
replicaRuntimeto the response with the200statusresponse-optional-property-added
- ○
- ○
added the optional property
backendVersionto the response with the200statusresponse-optional-property-added
- ○
added the optional property
rolloutto the response with the200statusresponse-optional-property-added
- ○
added the optional property
rolloutRoleto the response with the200statusresponse-optional-property-added
- ○