Information
- License: MIT
- OpenAPI version:
3.1.0
Overview
Status, port control, settings and updates for the Power Manifold controller.
Power Manifold API 0.20.3
Section titled “Power Manifold API 0.20.3”The controller’s HTTP API. Every path is on the controller itself, at
http://<name>.local/ or its IP address. With
HTTPS on, use
https:// and a name on the certificate; port 80 then answers every
request with 307 Temporary Redirect to the same path over HTTPS.
Authentication. Reading the status, the fault log, the certificate
details and the metrics needs no credential unless auth_read is on.
Everything else (and those four when auth_read is on) needs the API
token as a bearer token: Authorization: Bearer <token>. A controller with
no token refuses every change until
first-time setup
sets one.
Host names. The Host header must be the controller’s IP address, its
device name, the device name with .local, or one of its
host names.
Any other name gets 403 Forbidden with an HTML page.
Errors. A refused JSON request gets an object with one error string
that says why, such as {"error": "watts out of range"}. The wording can
change between releases; use the status code to tell cases apart.
Request bodies. Send JSON bodies with Content-Type: application/json.
The settings refuse any other type during first-time setup. Request
headers and a JSON body together must stay under 6 KB.
Worked examples are on the HTTP API page.
Authentication
Section titled “Authentication”The API token from the controller’s settings.
Security scheme type: http
USB Type-C® and USB-C® are registered trademarks of USB Implementers Forum.