# Health Check

<figure><img src="/files/EG8ehQsWSMNbw7lVXwdf" alt=""><figcaption></figcaption></figure>

## API

The **API** section provides a real-time status of the API services, showing whether they are currently running and accessible. It includes:

* **Status**: Displays if the API services are active and functioning.
* **URL**: Provides the direct link to access the API, ensuring connectivity for client requests.
* **PostgreSQL Database**: Indicates the operational status of the PostgreSQL database, essential for data storage and retrieval.
* **Neo4j Graph Database**: Displays the status of the Neo4j graph database, which supports complex relationships and queries within the data structure.

<figure><img src="/files/P0FwfgYmHDFiCSVCHffy" alt=""><figcaption></figcaption></figure>

## Core

The Core section monitors the core application’s underlying infrastructure and services, detailing:

* **Status**: Shows if the core services are up and running.
* **URL**: Lists the URL endpoint for the core service, which is vital for backend processes.
* **PostgreSQL Database**: Reflects the status of the core’s connection to PostgreSQL, enabling reliable data management.
* **Neo4j Graph Database**: Shows the connectivity to the Neo4j graph database, supporting the application’s relationship-driven data needs.
* **HangFire Service**: Displays the operational status of HangFire, responsible for handling background job processing and scheduling.

<figure><img src="/files/TCOfUyiXkyDyp2OhWTUO" alt=""><figcaption></figcaption></figure>

## System Usage

The System Usage section provides insights into resource consumption, helping monitor and manage system performance:

* **CPU Usage**: Displays the current CPU load, indicating how much processing power is in use.
* **Memory Usage**: Shows memory utilization, helping track whether available memory is sufficient for operations.
* **Disk Usage**: Indicates disk storage consumption, highlighting free and used space to prevent storage overload.
* **Path**: Specifies the directory path where the application is stored, useful for file management.
* **Version**: Displays the current version of the FsProtect, allowing for version tracking and updates.

<figure><img src="/files/teTUfaYFXxnop7JURlCU" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: 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:

```
GET https://docs.forestall.io/fsprotect/health-check.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
