ExternalVendorCode/balena-supervisor
1
0
Fork 0
mirror of https://github.com/balena-os/balena-supervisor.git synced 2025-01-31 08:25:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Add documentation for the v2/applications/state endpoint

Browse Source 
Change-type: patch
Closes: #719
Signed-off-by: Cameron Diver <cameron@resin.io>
This commit is contained in:
Cameron Diver 2018-08-07 13:42:55 +01:00
parent 233f4af1df
commit 409a582507
No known key found for this signature in database
GPG Key ID: 69264F9C923F55C1
1 changed files with 49 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docs/API.md
View File

@ -567,3 +567,52 @@ $ curl -X POST --header "Content-Type:application/json" \
--data '{"uuid": <uuid>, "method": "GET"}' \
"https://api.resin.io/supervisor/v1/device/host-config"
```
### GET /v2/applications/state
Added in supervisor v7.12.0
Get a list of applications, services and their statuses. This will reflect the
current state of the supervisor, and not the target state.
From the user container:
```bash
$ curl "$RESIN_SUPERVISOR_ADDRESS/v2/applications/state?apikey=$RESIN_SUPERVISOR_API_KEY"
```
Response:
```json
{
"appname": {
"appId": 1011165,
"commit": "217d55237092995e4576367e529ebb03",
"services": {
"main": {
"status": "Downloaded",
"releaseId": 557617,
"downloadProgress": null
},
"frontend": {
"status": "Downloading",
"releaseId": 557631,
"downloadProgress": 0
},
"proxy": {
"status": "Downloaded",
"releaseId": 557631,
"downloadProgress": null
},
"data": {
"status": "Downloading",
"releaseId": 557631,
"downloadProgress": 7
},
"metrics": {
"status": "Downloading",
"releaseId": 557631,
"downloadProgress": 35
}
}
}
}
```