openbmc/docs/REST-cheatsheet.md

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:
28 …curl -c cjar -b cjar -k -H "Content-Type: application/json" -X POST https://${bmc}/login -d "{\"da…
31 - If passing in the username/password as part of the URL, no unique login call
42  curl -k -X GET https://root:0penBmc@${bmc}/xyz/openbmc_project/list
45 - Token based authentication.
49 …-k -H "Content-Type: application/json" -X POST https://${bmc}/login -d '{"username" :  "root", "pa…
50  curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/...
57 Note: To keep the syntax below common between the phosphor-rest and bmcweb
63 …-k -H "Content-Type: application/json" -X POST https://${bmc}/login -d '{"username" :  "root", "pa…
64 curl -k -H "X-Auth-Token: $token" https://$bmc/xyz/openbmc_project/...
67 - List and enumerate:
70  curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/list
71  curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/enumerate
74 - List sub-objects:
77  curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/
78  curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/state/
81 - Host soft power off:
84 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -d '{"data": "xyz.openbmc_project…
87 - Host hard power off:
90 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT -d '{"data":"xyz.openbmc_p…
93 - Host power on:
96 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -d '{"data": "xyz.openbmc_project…
99 - Reboot Host:
102 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT -d '{"data":"xyz.openbmc_p…
105 - Reboot BMC:
108 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT -d '{"data":"xyz.openbmc_p…
111 - Display logging entries:
114 …curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X GET https://${bmc}/xyz/op…
117 - Delete logging entries:
120 …curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X DELETE https://${bmc}/xyz…
121 …curl -k -H "X-Auth-Token: $token" -H 'Content-Type: application/json' -X POST -d '{"data":[]}' htt…
124 - Delete dump entries:
127 …curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X DELETE https://${bmc}/xyz…
128 …curl -k -H "X-Auth-Token: $token" -H 'Content-Type: application/json' -X POST -d '{"data":[]}' htt…
131 - Delete images from system:
132   - Delete image:
135 …curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST -d '{"data": []}' ht…
138 - Delete all non-running images:
141 …curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST -d '{"data": []}' ht…
144 - Clear gard records:
147 …curl -k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X POST -d '{"data":[]}' htt…
150 - 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/enumerate
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/op…
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/op…
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/op…
187 - Set NTP and Nameserver:
190   - NTP Server:
193 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT -d '{"data": ["pool.ntp.or…
196 - Name Server:
199 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT -d '{"data": ["time.google…
202 - Configure time ownership and time sync method:
205   <https://github.com/openbmc/phosphor-time-manager>
211   -When NTP server is set to disabled, and the NTP service is stopping but not
218   - Read:
221 …curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/xyz/openbmc_project/time/owner/attr/TimeOw…
222 …curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/xyz/openbmc_project/time/sync_method/attr/…
225 - Write:
230 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X  PUT -d '{"data": "xyz.openbmc…
231 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X  PUT -d '{"data": "xyz.openbmc…
232 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X  PUT -d '{"data": "xyz.openbmc…
233 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X  PUT -d '{"data": "xyz.openbmc…
239 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X  PUT -d '{"data": "xyz.openbmc…
240 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X  PUT -d '{"data": "xyz.openbmc…
243 - Power Supply Redundancy:
244   - Read:
247 …curl -k -H "X-Auth-Token: $token" -X GET https://${bmc}/xyz/openbmc_project/control/power_supply_r…
250 - Write (Enable/Disable):
253 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT https://${bmc}/xyz/openbmc…
254 …-k -H "X-Auth-Token: $token" -H "Content-Type: application/json" -X PUT https://${bmc}/xyz/openbmc…
257 - Factory Reset:
258   - Factory reset host and BMC software:
261 …curl -k -H "X-Auth-Token: $token" -H 'Content-Type: application/json' -X POST -d '{"data":[]}' htt…
264 - Factory reset network setting:
267 …curl -k -H "X-Auth-Token: $token" -H 'Content-Type: application/json' -X POST -d '{"data":[]}' htt…
270 - Enable field mode:
273 …curl -k -H "X-Auth-Token: $token" -H 'Content-Type: application/json' -X PUT -d '{"data":1}' https…