> For the complete documentation index, see [llms.txt](https://docs.cybus.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cybus.io/1-10-2/documentation/system-status/system-health.md).

# System Health

The Connectware REST interface provides a unique */api/system/health* endpoint that can be used to retrieve health data information about system containers.

## Overview

The information provided by the endpoint are as follows:

## **System**

Overall object key

**Status:** Array of system container

**Name:** Name of the system container

**Status:** Current status of the system container

## **Resources**

Not implemented yet

## **Requirements**

To access the REST endpoint a user has to authenticate with Connectware first. HTTP *read* permissions for the */api/system/info* path have to be added to the user account before attempting to connect with the endpoint. To learn more about user permissions, please read the [User Section](/1-10-2/documentation/user-management.md) of the documentation.

{% code lineNumbers="true" %}

```yaml
curl -u <USERNAME>:<PASSWORD> https://<HOSTNAME>:443/api/system/health --insecure
```

{% endcode %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.cybus.io/1-10-2/documentation/system-status/system-health.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.