ExternalVendorCode/balena-supervisor
1
0
Fork 0
mirror of https://github.com/balena-os/balena-supervisor.git synced 2024-12-19 21:57:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #1931 from balena-os/clarify-v2-state-status-response-meaning

Browse Source 
Explain /v2/state/status's status field in its response
This commit is contained in:
bulldozer-balena[bot] 2022-04-18 20:32:39 +00:00 committed by GitHub
commit f8f337cbc5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/API.md
View File

@ -747,6 +747,8 @@ Response:
This will return a list of images, containers, the overall download progress and the status of the state engine.
> **Note:** The `status` field in the JSON response does not indicate the status of the device itself, but rather the status of the HTTP response. To get an accurate representation of whether the device state has settled, use the `appState` field. `appState` will be one of `applying` or `applied`.
From an app container:
```bash
curl "$BALENA_SUPERVISOR_ADDRESS/v2/state/status?apikey=$BALENA_SUPERVISOR_API_KEY"