Platform
Health check
Returns the health status of the API server.
At a glance
| Item | Value |
|---|---|
| Method | GET |
| Path | /v1/health |
| Auth | None |
Quick request
Use this as a starting point. Replace the placeholder IDs and set PGBEAM_TOKEN if the endpoint requires auth.
curl -X GET \
"$PGBEAM_API_URL/v1/health"Response Body
application/json
application/json
curl -X GET "https://api.pgbeam.com/v1/health"{
"status": "ok",
"version": "1.0.0",
"image_sha": "f1f01eda9e1bc25a3a1d28b1e18c5579fa9a128fede12169d3a392504f9729e4",
"timestamp": "2019-08-24T14:15:22Z"
}{
"error": {
"code": "string",
"message": "string"
}
}