Skip to main content
GET
/
health
API Health Check
curl --request GET \
  --url https://api.g2cplatform.com/v2/health \
  --header 'X-API-Key: <api-key>'
{
  "status": "healthy",
  "timestamp": "2023-11-07T05:31:56Z",
  "version": "2.0.0",
  "uptime": 123,
  "checks": {
    "database": "healthy",
    "blockchain": "healthy",
    "storage": "healthy"
  }
}

Authorizations

X-API-Key
string
header
required

API key for authenticating requests. Include in X-API-Key header.

Response

API is healthy and operational

status
enum<string>
required

Overall system health status

Available options:
healthy,
degraded,
unhealthy
timestamp
string<date-time>
required

Timestamp of the health check

version
string
required

API version

Example:

"2.0.0"

uptime
integer

System uptime in seconds

checks
object