Skip to content
RipsClouddevelopers

Check API health — Service status

GET/health

Operation ID: system.getHealth · Access: public · Effect: read.

Responses

Section titled “Responses”
HTTP Content Schema
200 application/json Health
400 application/json ApiError
500 application/json ApiError
503 application/json ApiError

Use error.code, error.issues, and requestId for JSON errors. Error and recovery guide.

cURL

Section titled “cURL”

Set the connection variables from the quickstart. Set each path variable to an authorized identifier or an allowed parameter value from the table above.

Terminal window
curl --fail-with-body --request GET \
  "$RIPSCLOUD_BASE_URL/health" \
  --header 'Accept: application/json'