Zum Hauptinhalt springen
Internal notes
TitleIntroduction: Legacy REST API
Statusdraft ✏
Sources
Preview Link...
Version: 5.32

Introduction: Legacy REST API

Intro​

The following explains how to use the REST API to retrieve Charge Controller information.

info
  • In order to use the REST interface, it must first be enabled in the Operator Settings under "REST interface".
  • The REST API can currently only be used to read out ("read-only") the parameters.

Enabling the Legacy REST API​

In the Dashboard, under SYSTEM / General set REST interface to Enabled (without UID).

REST API over HTTP​

HTTP header parameters​

Use the following HTTP header parameters for queries:

ParameterValue
AuthorizationBasic AuthM
Usernameoperator or manufacturerM
Passwordoperator/manufacturer passwordM
Content Typeapplication/jsonM

Example requests​

You can get the Charge Controller's state via the REST API.

With the following GET request you can retrieve the status with an existing USB connection:

curl -XGET -H 'Authorization: Basic Auth' -H 'Username: operator' -H 'Password: your_password' -H "Content-type: application/json" 'http://192.168.123.123/rest/full_state'