---
title: Health Check API
slug: health-check-api
createdAt: 2022-05-08T20:22:01.000Z
---



| Production API Endpoint | [[https://api.oelite.io](https://api.oelite.io)](https://ama.api.oelite.io)                             |
| ----------------------- | ------------------------------------------------------------------------------------------------------- |
| Production API Swagger  | [[https://api.oelite.io/swagger](https://ama.api.oelite.io/swagger)](https://ama.api.oelite.io/swagger) |

# Health Checks

For checking the server APIs health, please make 2 API calls as listed below. Please make sure both responses return successful messages before carrying further function calls.

**/platform/ping**

This endpoint should return "pong" as a response to indicate the server is connectable

**/healthz**

This endpoint should return "Healthy" as response to indicate the server is functioning. The health check on server carries a set of checks including logic flow check, database connection check and performance check.



| Production API Endpoint | [[https://api.oelite.io](https://api.oelite.io)](https://ama.api.oelite.io)                         |
| ----------------------- | --------------------------------------------------------------------------------------------------- |
| Production API Swagger  | [[https://api.oelite.io/swagger](https://api.oelite.io/swagger)](https://ama.api.oelite.io/swagger) |

# Health Checks

For checking the server APIs health, please make 2 calls.

::::::VerticalSplit{layout="right"}
:::VerticalSplitItem


## Server connection status check

This endpoint should return "pong" as a response to indicate the server is connectable. The server should return string "pong" very quickly as it does not carry any logic checks.&#x20;



This check is useful for your application to evaluate whether the connection in good quality (slow/fast).&#x20;



### Parameters

No parameter is required.

***

### Response

A string "**pong**" should be expected. If not, there's a problem connecting to the server.
:::

:::::VerticalSplitItem
::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**GET**
:::

:::VerticalSplitItem
/platform/ping
:::
::::

***

```json






```

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**Response**
:::

:::VerticalSplitItem

:::
::::

***

```json
"pong"





```












:::::
::::::



::::::VerticalSplit{layout="right"}
:::VerticalSplitItem


## Server health check

This endpoint should return "



### Parameters

**param1   &#x20;**<font color="#ff6900">REQUIRED</font>

description here...

***

**param2   &#x20;**<font color="#888888">optional</font>

description here

***

### Response

A string will be returned. The value can be any of the following:



**Healthy** &#x20;

indicates the server is running in good health.

﻿

**Degraded**

indicates the server is running however in degraded performance.



**Unhealthy**

indicates the server is having problems and may not be functioning properly.



:::

:::::VerticalSplitItem
::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**GET**
:::

:::VerticalSplitItem
/platform/ping
:::
::::

***

```json






```

::::VerticalSplit{layout="left"}
:::VerticalSplitItem
**Response**
:::

:::VerticalSplitItem

:::
::::

***

```json






```












:::::
::::::

