> For the complete documentation index, see [llms.txt](https://teos-docs.coreledger.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://teos-docs.coreledger.net/guides/health/health-check.md).

# Health Check

This endpoint is used to verify the availability and health of the TEOS API, as well as to confirm the validity of API keys.\
It performs no business logic and returns an empty successful response if the service is operational.

#### **Request Endpoint**

```http
GET /odata/v1.0/Ping
```

#### **Description**

* This method can be called to ensure that the TEOS API is online and responsive.
* It is also used to check whether the provided API key or authorization token is valid.
* The endpoint does not require any parameters or body payload.

#### **Usage**

**Typical use cases:**

* Automated health checks (e.g., by monitoring systems).
* Pre-flight validation of connectivity and credentials before sending other API requests

#### **Parameters**

None.

#### **Responses**

| **Code** | **Description**                                                                  |
| -------- | -------------------------------------------------------------------------------- |
| 200      | OK. The TEOS API is healthy, and the API key (if provided) is valid.             |
| 401      | Unauthorized. The provided API key or authorization token is missing or invalid. |

\
.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://teos-docs.coreledger.net/guides/health/health-check.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.