Skip to content

Health Check APIs

Only available in runner distribution

Fetch Health status of the Siddhi Runner

Overview

Description Fetches the health status of the Siddhi Runner.
API Context /health
HTTP Method GET
Request/Response Format application/json
Authentication Not Required
Username N/A
Password N/A
Runtime Runner

curl command syntax

1
curl -k -X GET http://localhost:9090/health

Sample curl command

1
curl -k -X GET http://localhost:9090/health

Sample output

1
{"status":"healthy"}

Response

HTTP Status Code Possible codes are 200 and 404.
For descriptions of the HTTP status codes, see HTTP Status Codes
Top