Skip to main content
GET
/
health
Health Check
curl --request GET \
  --url https://api.example.com/health
{
  "status": "<string>",
  "service": "<string>"
}

​
Health Check

Simple health check endpoint for the attestation service.

​
Endpoint

GET /health

​
Authentication

No authentication required.

​
Response

Returns the service status and name.
​
status
string
required
Service status (always “healthy”)
​
service
string
required
Service identifier (“attestation-service”)

​
Example

curl https://your-attestation-service.com/health

​
Response

{
  "status": "healthy",
  "service": "attestation-service"
}

​
Implementation Details

This endpoint is useful for monitoring and health checks in orchestration systems like Docker Compose or Kubernetes.
Source: cvm/attestation-service/attestation_service.py:176-179

Build docs developers (and LLMs) love

Get started for freeTalk to us