openbmc/docs/rest-api.md

24 $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/...
36   $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/inventory/system
59 …$ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/inventory/system/attr/Cached
71   $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/
74    "/xyz/openbmc_project/Chassis",
75    "/xyz/openbmc_project/Hiomapd",
76    "/xyz/openbmc_project/Ipmi",
77    "/xyz/openbmc_project/certs",
78    "/xyz/openbmc_project/console",
79    "/xyz/openbmc_project/control",
80    "/xyz/openbmc_project/dump",
81    "/xyz/openbmc_project/events",
82    "/xyz/openbmc_project/inventory",
83    "/xyz/openbmc_project/ipmi",
84    "/xyz/openbmc_project/led",
85    "/xyz/openbmc_project/logging",
86    "/xyz/openbmc_project/network",
87    "/xyz/openbmc_project/object_mapper",
88    "/xyz/openbmc_project/sensors",
89    "/xyz/openbmc_project/software",
90    "/xyz/openbmc_project/state",
91    "/xyz/openbmc_project/time",
92    "/xyz/openbmc_project/user"
99   This shows that there are 19 children of the `openbmc_project/` object:
108   $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/network/list
111    "/xyz/openbmc_project/network/config",
112    "/xyz/openbmc_project/network/config/dhcp",
113    "/xyz/openbmc_project/network/eth0",
114    "/xyz/openbmc_project/network/eth0/ipv4",
115    "/xyz/openbmc_project/network/eth0/ipv4/3b9faa36",
116    "/xyz/openbmc_project/network/eth0/ipv6",
117    "/xyz/openbmc_project/network/eth0/ipv6/ff81b6d6",
118    "/xyz/openbmc_project/network/eth1",
119    "/xyz/openbmc_project/network/eth1/ipv4",
120    "/xyz/openbmc_project/network/eth1/ipv4/3b9faa36",
121    "/xyz/openbmc_project/network/eth1/ipv4/66e63348",
122    "/xyz/openbmc_project/network/eth1/ipv6",
123    "/xyz/openbmc_project/network/eth1/ipv6/ff81b6d6",
124    "/xyz/openbmc_project/network/host0",
125    "/xyz/openbmc_project/network/host0/intf",
126    "/xyz/openbmc_project/network/host0/intf/addr",
127    "/xyz/openbmc_project/network/sit0",
128    "/xyz/openbmc_project/network/snmp",
129    "/xyz/openbmc_project/network/snmp/manager"
140   $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/time/enumerate
143    "/xyz/openbmc_project/time/bmc": {
146    "/xyz/openbmc_project/time/host": {
149    "/xyz/openbmc_project/time/owner": {
150      "TimeOwner": "xyz.openbmc_project.Time.Owner.Owners.BMC"
152    "/xyz/openbmc_project/time/sync_method": {
153      "TimeSyncMethod": "xyz.openbmc_project.Time.Synchronization.Method.NTP"
168 $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/state/host0 > host.json
173     "BootProgress": "xyz.openbmc_project.State.Boot.Progress.ProgressStages.Unspecified",
174     "CurrentHostState": "xyz.openbmc_project.State.Host.HostState.Off",
175     "OperatingSystemState": "xyz.openbmc_project.State.OperatingSystem.Status.OSStatus.Inactive",
176     "RequestedHostTransition": "xyz.openbmc_project.State.Host.Transition.Off"
186 $ curl -k -H "X-Auth-Token: $token" https://${bmc}/xyz/openbmc_project/state/host0/attr/RequestedHo…
189   "data": "xyz.openbmc_project.State.Host.Transition.Off",
213 {"data": "xyz.openbmc_project.State.Host.Transition.Off"}
214 …: application/json" -X PUT -T requested_host.json https://${bmc}/xyz/openbmc_project/state/host0/a…
220 …ation/json" -X PUT -d '{"data": "xyz.openbmc_project.State.Host.Transition.On"}' https://${bmc}/xy…
234 …-Type: application/json' -X POST -d '{"data":[]}' https://${bmc}/xyz/openbmc_project/logging/actio…
240 …-Type: application/json' -X POST -d '{"data":[]}' https://${bmc}/xyz/openbmc_project/software/acti…
247 `xyz.openbmc_project.Object.Delete` interface the REST server will call it. If
248 `xyz.openbmc_project.Object.Delete` is not implemented, the REST server will
256 …token" -H "Content-Type: application/json" -X GET https://${bmc}/xyz/openbmc_project/logging/entry…
262 …n" -H "Content-Type: application/json" -X DELETE  https://${bmc}/xyz/openbmc_project/logging/entry…
351     "paths": ["/xyz/openbmc_project/logging", "/xyz/openbmc_project/sensors"],
352     "interfaces": ["xyz.openbmc_project.Logging.Entry", "xyz.openbmc_project.Sensor.Value"]
362     "paths": ["/xyz/openbmc_project/logging", "/xyz/openbmc_project/sensors"],
372     "interfaces": ["xyz.openbmc_project.Logging.Entry", "xyz.openbmc_project.Sensor.Value"]