---
title: "Get system health REST API | HitKeep"
description: "Reference for the HitKeep REST API operation Get system health, including request parameters, responses, and authentication notes."
canonical: "https://hitkeep.com/api/operations/apiadminsystemhealth/"
---

# Get system health REST API

GET

/api/admin/system/health

FetchcURL

```
const url = 'http://127.0.0.1:25737/api/admin/system/health';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```
curl --request GET \
  --url http://127.0.0.1:25737/api/admin/system/health \
  --cookie hk_token=<hk_token>
```

-

Returns instance health, database status, worker status, and cluster leader state.

## Authorizations

- **[cookieAuth](https://hitkeep.com/api/#cookieauth)**

## Responses

### 200

System health

application/json

object

**database**

string

**is_leader**

boolean

**status**

string

**workers**

string

##### Examplegenerated

```
{
  "database": "example",
  "is_leader": true,
  "status": "example",
  "workers": "example"
}
```

[Previous Checkpoint the shared database](https://hitkeep.com/api/operations/apiadminsystemdatabasecheckpoint/)[Next Get import staging cleanup status](https://hitkeep.com/api/operations/apiadminsystemimport-stage-cleanup/)