Skip to main content
GET
/
auth
/
health
APIKEY Health Check
curl --request GET \
  --url https://api.g2cplatform.com/v2/auth/health \
  --header 'X-API-Key: <api-key>'
{
  "status": "healthy",
  "timestamp": "2023-11-07T05:31:56Z",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connectivity": {
    "database": "connected",
    "blockchain": "connected"
  }
}

Authorizations

​
X-API-Key
string
header
required

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

Response

Company health status retrieved successfully

​
status
enum<string>
required
Available options:
healthy,
degraded,
unhealthy
​
timestamp
string<date-time>
required
​
companyId
string<uuid>
required
​
connectivity
object