Sign in
Health

Health check

Get the health status of the yield API with current timestamp

get/health

Request

  • Base URL: https://api.yield.xyz
  • URL: https://api.yield.xyz/health
  • Auth: none declared

Response

Health check status with timestamp

status'OK' | 'FAIL' required

The health status of the service

timestampstring date-time required

Timestamp when the health check was performed

Example response

{
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.