5.21. Examining Builds Using the Toaster API

Toaster is an Application Programming Interface (API) and web-based interface to the OpenEmbedded build system, which uses BitBake. Both interfaces are based on a Representational State Transfer (REST) API that queries for and returns build information using GET and JSON. These types of search operations retrieve sets of objects from a datastore used to collect build information. The results contain all the data for the objects being returned. You can order the results of the search by key and the search parameters are consistent for all object types.

Using the interfaces you can do the following:

Note

This release of Toaster provides you with information about a BitBake run. The tool does not allow you to configure and launch a build. However, future development includes plans to integrate the configuration and build launching capabilities of Hob.

For more information on using Hob to build an image, see the "Image Development Using Hob" section.

The remainder of this section describes what you need to have in place to use Toaster, how to start it, use it, and stop it. For additional information on installing and running Toaster, see the "Installation and Running" section of the "Toaster" wiki page. For complete information on the API and its search operation URI, parameters, and responses, see the REST API Contracts Wiki page.