> For the complete documentation index, see [llms.txt](https://docs.helmut.de/helmut4-releases/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.helmut.de/helmut4-releases/support/debug-or-log-collection/helmut4-client/local-client-api.md).

# Local Client API

You can use an API to check the current status of the Helmut4 client.

Sending a GET request to the specified endpoint <http://localhost:8880/v1/hc/info> (http) or <https://localhost:8881/v1/hc/info> (https) will yield a response indicating whether the client is running and its connection state.

#### Response for a connected client (macOS)

```json
{
    "version": "4.2.036",
    "endPoint": "https://helmut.example",
    "token": "Bearer ##token##",
    "idle": 0.0,
    "sessionToken": "b68ed27c-b288-4e37-acb6-05ccb3ea9fb8",
    "sso": null,
    "os": "MAC"
}
```

#### Response for a disconnected client (macOS)

```json
{
    "version": "4.2.0.36",
    "endPoint": null,
    "token": null,
    "idle": 0.0,
    "sessionToken": "b68ed27c-b288-4e37-acb6-05ccb3ea9fb8",
    "sso": null,
    "os": "MAC"
}
```


---

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

```
GET https://docs.helmut.de/helmut4-releases/support/debug-or-log-collection/helmut4-client/local-client-api.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.