Skip to main content
GET
/
health
Service health check
curl --request GET \
  --url https://api.strettch.cloud/api/v1/health
{
  "message": "Operation successful",
  "requestId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "success": true,
  "timestamp": "2024-01-15T10:00:00Z",
  "data": {
    "service": "public-api",
    "status": "ok"
  }
}

Response Error Codes

If the request fails, the code field in the error response will contain one of the following.
CodeStatusDescription
OK200The service and its critical dependencies are healthy.
INTERNAL_SERVER_ERROR500An unexpected error occurred while performing the health check.

Response

200 - application/json

OK

message
string
Example:

"Operation successful"

requestId
string
Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

success
boolean
Example:

true

timestamp
string
Example:

"2024-01-15T10:00:00Z"

data
object