Get system health status

GET

/health/

GET

/account/health/

1 const url = 'https://api.etera.dev/account/health/';
2 const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
3 
4 try {
5   const response = await fetch(url, options);
6   const data = await response.json();
7   console.log(data);
8 } catch (error) {
9   console.error(error);
10 }

1 {
2   "status": "healthy",
3   "timestamp": "2024-07-01T12:00:00Z",
4   "version": "1.0.0",
5   "uptime": 12345,
6   "services": {
7     "database": {
8       "status": "healthy",
9       "responseTime": 10
10     },
11     "redis": {
12       "status": "healthy",
13       "responseTime": 5
14     },
15     "kafka": {
16       "status": "healthy",
17       "responseTime": 8
18     },
19     "s3": {
20       "status": "healthy",
21       "responseTime": 12
22     }
23   },
24   "checks": {
25     "total": 4,
26     "healthy": 4,
27     "unhealthy": 0
28   }
29 }

Comprehensive health check for all system dependencies including database, Redis, Kafka, and S3.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

System health status

statusenum

Allowed values:

timestampdatetime

versionstring

uptimedouble

servicesobject

checksobject

Errors

500

Internal Server Error

503

Service Unavailable Error