Skip to main content
GET
/
health
Health check
curl --request GET \
  --url https://api.yield.xyz/health
{
  "status": "OK",
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://yieldxyz.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Response

200 - application/json

Health check status with timestamp

​
status
enum<string>
required

The health status of the service

Available options:
OK,
FAIL
Example:

"OK"

​
timestamp
string<date-time>
required

Timestamp when the health check was performed

Example:

"2024-01-15T10:30:00.000Z"