STstudio-saelix
Stacks

Get post-update health gate result

Changed on

Returns a post-deploy health gate observation for the stack: the run named by gateId (as returned in a deploy or update response), or the most recent run when omitted. Status never-run means no observation exists. Requires stack:read permission.

get/api/stacks/{stackName}/health-gate

Request

  • Base URL
    https://localhost:1852
  • URL
    https://localhost:1852/api/stacks/{stackName}/health-gate
  • Auth
    HTTP bearer

Path parameters

stackNamestring required
Example:my-stack

Stack directory name. Must match ^[a-zA-Z0-9_-]+$ (alphanumeric characters, hyphens, and underscores only). Returns 400 Invalid stack name if the name contains path separators, dots, spaces, or other special characters.

Query parameters

gateIdstring

A specific gate run id to read instead of the latest.

Headers

x-node-idinteger
Example:1

Target a specific node by ID. If omitted, the default node is used. Can also be passed as ?nodeId= query parameter.

Response

Health gate report.

stackstring required
idstring nullable
status'observing' | 'passed' | 'failed' | 'unknown' | 'never-run' required
trigger'update' | 'deploy' | 'service_update' | 'service_restore' | 'null' nullable
reasonstring nullable
windowSecondsinteger nullable
startedAtinteger nullable
endedAtinteger nullable
targetScope'stack' | 'service'

Defaults to stack for legacy runs.

serviceNamestring nullable
failureSource'primary' | 'collateral' | 'null' nullable

Set on failed service-scoped runs; null for stack and successful runs.

Changes

  • dd7290a948b8Revision changes
    • warning

      added the new service_restore enum value to the response property for the response status

    • warning

      added the new service_update enum value to the response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 0c52a6705499Revision changes
    • info

      endpoint added