Skip to main content

Health Check

Stable

Type: DEVRAMPS:APPROVAL:HEALTH_CHECK

Category: approval

Version: 1.0.0


Description

Verify deployed services are healthy by checking HTTP endpoints.

Makes HTTP GET requests to one or more endpoints after a deployment and checks for successful (2xx) responses. If all endpoints respond successfully, the pipeline automatically proceeds. If any endpoint fails after exhausting retries, the pipeline is blocked for investigation. Each endpoint has its own independent retry budget. Useful as a post-deployment confidence gate to catch issues early.

Parameters

Required Parameters

ParameterTypeDescription
endpointsarray<object>List of HTTP endpoints to health check.

Optional Parameters

ParameterTypeDefaultDescription
retriesinteger5Maximum retry attempts per endpoint before failing (max 100).
interval_secondsinteger10Seconds to wait between retry attempts.
timeout_secondsinteger5Per-request timeout in seconds.

Example Usage

- type: DEVRAMPS:APPROVAL:HEALTH_CHECK
name: Verify API Health
params:
endpoints:
- url: "https://api.staging.example.com/health"
- url: "https://api.staging.example.com/readiness"
retries: 5
interval_seconds: 10
timeout_seconds: 5