openbmc/docs/rest-api.md

1 # OpenBMC REST API
3 The OpenBMC REST API is disabled by default in bmcweb. Most of the functionality
5 examples for the OpenBMC REST interface.
7 The schema for the rest interface is directly defined by the OpenBMC D-Bus
17 [REST-cheatsheet](https://github.com/openbmc/docs/blob/master/REST-cheatsheet.md#establish-rest-con…
29 There are a few conventions on the URL structure of the OpenBMC rest interface.
101   the base REST URL (ie., `http://${bmc}/`), to discover all objects in the
229 new resources via REST so any attempt to create a new resource will result in a
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
268 or host software) via REST. The content-type should be set to
277 In above example, the filename on the BMC will be chosen by the REST server.
317 don't have do employ polling. Instead, the rest server on the BMC can push data
388 d) The rest server on the BMC will respond over the websocket when a D-Bus event
389 occurs, considering the client supplied filters. The rest servers notifies about