openbmc/docs/REST-cheatsheet.md

11 ### Notes on authentication:
13 The original REST server, from the phosphor-rest-server repository, uses
15 use the same cookie jar files for read-only REST methods like GET, but requires
17 the URL for non-read-only methods.
20 server. The phosphor-rest-server repository was archived in October 2022.
24 - Using just the cookie jar files for the phosphor-rest server:
27 …$ curl -c cjar -b cjar -k -H "Content-Type: application/json" -X POST https://${bmc}/login -d "{\"…
29 - If passing in the username/password as part of the URL, no unique login call
40   $ curl -k -X GET https://root:0penBmc@${bmc}/xyz/openbmc_project/list
43 - Token based authentication.
47 …-k -H "Content-Type: application/json" -X POST https://${bmc}/login -d '{"username" :  "root", "pa…
48   $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/...
55 Note: To keep the syntax below common between the phosphor-rest and bmcweb
61 …-k -H "Content-Type: application/json" -X POST https://${bmc}/login -d '{"username" :  "root", "pa…
62 $ curl -k -H "X-Auth-Token: $token" https://$bmc/xyz/openbmc_project/...
65 - List and enumerate:
68   $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/list
69   $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/enumerate
72 - List sub-objects:
75   $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/
76   $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/state/
79 - Host soft power off:
82 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -d '{"data": "xyz.openbmc_…
85 - Host hard power off:
88 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT -d '{"data":"xyz.op…
91 - Host power on:
94 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -d '{"data": "xyz.openbmc_…
97 - Reboot Host:
100 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT -d '{"data":"xyz.op…
103 - Reboot BMC:
106 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT -d '{"data":"xyz.op…
109 - Display logging entries:
112 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X GET https://${bmc}/xyz/…
115 - Delete logging entries:
118 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X DELETE https://${bmc}/x…
119 …$ curl -k -H "X-Auth-Token: $token" -H 'Content-Type: application/json' -X POST -d '{"data":[]}' h…
122 - Delete dump entries:
125 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X DELETE https://${bmc}/x…
126 …$ curl -k -H "X-Auth-Token: $token" -H 'Content-Type: application/json' -X POST -d '{"data":[]}' h…
129 - Delete images from system:
131   - Delete image:
134 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST -d '{"data": []}' …
137   - Delete all non-running images:
140 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST -d '{"data": []}' …
143 - Clear gard records:
146 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST -d '{"data":[]}' h…
149 - Control boot source override:
151   - Read current boot source override settings:
154 …$ curl -k -H "X-Auth-Token: $token"  https://${bmc}/xyz/openbmc_project/control/host0/boot/enumera…
157   - Set boot source:
160 …curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT https://${bmc}/xyz/op…
163   - Set boot mode:
166 … curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT https://${bmc}/xyz/o…
169   - Set boot type (valid only if host is based on the x86 CPU):
172 … curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT https://${bmc}/xyz/o…
175   - Set boot source override persistent:
178 …l -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT https://${bmc}/xyz/openb…
181   - Enable boot source override:
184 … curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT https://${bmc}/xyz/o…
187 - Set NTP and Nameserver:
191   - NTP Server:
194 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT -d '{"data": ["pool…
197   - Name Server:
200 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT -d '{"data": ["time…
203 - Configure time ownership and time sync method:
206   https://github.com/openbmc/phosphor-time-manager
212   -When NTP server is set to disabled, and the NTP service is stopping but not
220   - Read:
223 …$ curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/xyz/openbmc_project/time/owner/attr/Time…
224 …$ curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/xyz/openbmc_project/time/sync_method/att…
227   - Write:
232 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X  PUT -d '{"data": "xyz.…
233 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X  PUT -d '{"data": "xyz.…
234 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X  PUT -d '{"data": "xyz.…
235 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X  PUT -d '{"data": "xyz.…
241 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X  PUT -d '{"data": "xyz.…
242 …$ curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X  PUT -d '{"data": "xyz.…
245 - Power Supply Redundancy:
247   - Read:
250 …$ curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/xyz/openbmc_project/control/power_supply…
253   - Write (Enable/Disable):
256 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT https://${bmc}/xyz/openbmc…
257 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT https://${bmc}/xyz/openbmc…
260 - Factory Reset:
262   - Factory reset host and BMC software:
265 …$ curl -k -H "X-Auth-Token: $token" -H 'Content-Type: application/json' -X POST -d '{"data":[]}' h…
268   - Factory reset network setting:
271 …$ curl -k -H "X-Auth-Token: $token" -H 'Content-Type: application/json' -X POST -d '{"data":[]}' h…
274   - Enable field mode:
277 …$ curl -k -H "X-Auth-Token: $token" -H 'Content-Type: application/json' -X PUT -d '{"data":1}' htt…