View source for Analysis REST API Contracts

[[Category:Toaster]]

* Implementation is released on http://git.yoctoproject.org/cgit/cgit.cgi/poky/log/?h=dora-toaster and http://git.yoctoproject.org/cgit/cgit.cgi/poky/log/?h=master

This page gives you information on the Toaster API and its search operation URI, parameters, and responses. You might also be interested in the [[Toaster#Installation and Running|Toaster installation and running instructions]].

Toaster is accessible through REST APIs, which make the backend available to any client.
The data collected during the build is available via an unrestricted, anonymous, read-only API running on the local host machine.

== General ==

The data interface is available as a search query returning a list of typed objects.
The request method must be GET. The answers are always returned as JSON.

=== API version ===

The REST API is versioned as to allow further upgrades without having to maintain backward compatibility through changing the major version number.
Minor version numbers are intended to signify a capability level while maintaining compatibility.

This is the API version 1.0. All API requests are grouped under URL: 
<p>
<code>GET /api/1.0/</code>
</p>
=== Object types ===

The API can return [[REST API Contracts#Build|Build]], [[REST API Contracts#Target|Target]], [[REST API Contracts#Target installed packages|Target installed packages]], [[REST API Contracts#Layer|Layer]], [[REST API Contracts#Layer version|Layer version]], [[REST API Contracts#Task|Task]], [[REST API Contracts#Task dependencies|Task dependencies]], [[REST API Contracts#Recipe|Recipe]], [[REST API Contracts#Recipe dependencies|Recipe dependencies]], [[REST API Contracts#Build packages|Build packages]], [[REST API Contracts#Package dependencies|Package dependencies]], [[REST API Contracts#Package files|Package files]], [[REST API Contracts#Variables|Variables]] and [[REST API Contracts#Log messages|Log messages]]. Each object is described below.

=== Search operation ===

The primary operation of the API is to retrieve a set of objects from the backend based on a search operation. The result will also contain all the data for the objects being returned, as to avoid separate connections to further bring the objects of the type queried.

The search operation can also specify the ordering of the results by key.

The search parameters are the same for all object types.

==== URI ====

All the search endpoints follow the same URI pattern

<p><code>
GET /api/1.0/{on}s/?{parameters}
</code>
</p>

* The <i>on</i> is the object name, one the endpoints described below.
* The <i>parameters</i> are described in the next section, and are the same for all search queries

==== Parameters ====

{| class="wikitable"
|-
! Name !! Type !! Description !! Comments 
|-
| limit || number || The number of objects to be returned ||  -
|-
| offset || number || Offset into the search result index. || -
|-
| search || string || Search string for all fields || The argument is the string to be searched in the database. The backend MUST return only records that match the string.
|-
| filter || string || String used to specify result filter function || The general form: "<FIELD>:<VALUE>[,<FIELD>:<VALUE>]*". The backend MUST only return records that have FIELD matching to the VALUE specified. The <FIELD> names for each object type are the property names of the object.
|-
| orderby || string || The name of the field that determines the sorting of the results. || "<FIELD>:<ORDER_DIRECTION>". The results are ordered by the <FIELD> values in the <ORDER_DIRECTION> order. <ORDER_DIRECTION> values may be "asc" or "desc". 
|}

==== Response ====

All the responses are in JSON format. The response contains a set of fields describing the content of the data, and an array with the object data inside it.


== Build ==

Returns information about the builds recorded by Toaster.

=== Endpoints ===

{| class="wikitable"
|-
! Method !! Endpoint !! Body !! Description !! Comments
|-
| GET || /api/1.0/builds || JSON || Returns page size-limited and search criteria-filtered builds from the database || -
|}

=== Response ===

{| class="wikitable"
|-
! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
|-
| [Object Root] || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#006600">count</span> || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter)  || -
|-
| [Object Root].<span style="color:#006600">list</span> || object array || - || YES || - || - || To describe a generic object element of the array, the reference to its root is "list[]"
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> || number || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> || string || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">outcome</span> || number || 2 || YES || - || Signals successful or failed build || 0 Failed build <br /> 1 Successful build
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">build_name</span> || string || - || YES || - || Build name|| Known issues: [http://bugzilla.yoctoproject.org/show_bug.cgi?id=5187 5187]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">machine</span> || string || - || YES || - || The selected hardware || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">started_on</span> || number representation of date || - || YES || - ||  Marks the moment the process is started || 
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">completed_on</span> || number representation of date || - || YES || - || Marks the moment the process is completed || 
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">errors_no</span> || number || - || YES || - || Number of errors thrown by the build || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">warnings_no</span> || number || - || YES || - || Number of warnings thrown by the build || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">image_fstypes</span> || string || - || YES || - || The file types create by this build || Space-separated file name suffixes. Known issues: [https://bugzilla.yoctoproject.org/show_bug.cgi?id=5453 5453]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">cooker_log_path</span> || string || - || YES || - || Path to log file || Known issues: [http://bugzilla.yoctoproject.org/show_bug.cgi?id=5187 5187]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">distro</span> || string || - || YES || - || Distro name || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">distro_version</span> || string || - || YES || - || Distro version || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">bitbake_version</span> || string || - || YES || - || BitBake version || -
|}

== Target ==

Returns information about a build target(s).

=== Endpoints ===

{| class="wikitable"
|-
! Method !! Endpoint !! Body !! Description !! Comments
|-
| GET || /api/1.0/targets || JSON || Returns page size-limited and search criteria-filtered targets from the database || -
|}

=== Response ===

{| class="wikitable"
|-
! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
|-
| [Object Root] || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#006600">count</span> || number || - || YES || - || Total amount of targets to be displayed (according to filter parameter)  || -
|-
| [Object Root].<span style="color:#006600">list</span> || object array || - || YES || - || - || To describe a generic object element of the array, the reference to its root is "list[]"
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> || number || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> || string || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">build</span> || number || - || YES || - || The ID of the build that created this target || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">target</span> || string || - || YES || - || The name of the build target || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">file_name</span> || string || - || YES || - || Full path(s) to the root file system file(s) produced by the build (if any) || Known issues: [http://bugzilla.yoctoproject.org/show_bug.cgi?id=5189 5189] 
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">file_size</span> || number || - || YES || - || The file size of the build target || Known issues: [http://bugzilla.yoctoproject.org/show_bug.cgi?id=5228 5228] 
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">is_image</span> || boolean || - || YES || False || True if one of the build targets is an image recipe || -
|}

== Target installed packages ==

Returns information about the packages installed in a target, when such target is an image recipe. 

NOTE: [http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#maintaining-build-output-quality Build history] <strong>must be enabled</strong> to collect this information.

=== Endpoints ===

{| class="wikitable"
|-
! Method !! Endpoint !! Body !! Description !! Comments
|-
| GET || /api/1.0/target_packages || JSON || Returns page size-limited and search criteria-filtered installed packages from the database || -
|}

=== Response ===

{| class="wikitable"
|-
! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
|-
| [Object Root] || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#006600">count</span> || number || - || YES || - || Total amount of packages to be displayed (according to filter parameter) || -
|-
| [Object Root].<span style="color:#006600">list</span> || object array || - || YES || - || - || To describe a generic object element of the array, the reference to its root is "list[]"
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> || number || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> || string || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">target</span> || number || - || YES || - || The pk of the target that has this package || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">recipe</span> || number || - || YES || - || The pk of the recipe that generated this package || Known issues: [http://bugzilla.yoctoproject.org/show_bug.cgi?id=5276 5276]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">name</span> || string || - || YES || - || Package name || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">version</span> || string || - || YES || - || Package version || Known issues: [http://bugzilla.yoctoproject.org/show_bug.cgi?id=5276 5276]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">size</span> || number || - || YES || - || The size of the package, in bytes || -
|-
|}

== Layer ==

Returns information about the layers used in the builds recorded by Toaster.

=== Endpoints ===

{| class="wikitable"
|-
! Method !! Endpoint !! Body !! Description !! Comments
|-
| GET || /api/1.0/layers || JSON || Returns page size-limited and search criteria-filtered layers from the database || -
|}


=== Response ===

{| class="wikitable"
|-
! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
|-
| [Object Root] || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#006600">count</span> || number || - || YES || - || Total amount of layers to be displayed (according to filter parameter) || -
|-
| [Object Root].<span style="color:#006600">list</span> || object array || - || YES || - || - || To describe a generic object element of the array, the reference to its root is "list[]"
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> || number || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> || string || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">name</span> || string || - || YES || - || The local name under which the layer is known || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">local_path</span> || string || - || YES || - || Path to the layer on local machine || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">layer_index_url</span> || URL || - || NO || - || URL to the layer index application || Possibly not available. Known issues: [http://bugzilla.yoctoproject.org/show_bug.cgi?id=5192 5192]
|-
|}

== Layer version ==

Returns information about the version (branch:commit in Git) of a layer used in a certain build.

=== Endpoints ===

{| class="wikitable"
|-
! Method !! Endpoint !! Body !! Description !! Comments
|-
| GET || /api/1.0/layerversions || JSON || Returns page size-limited and search criteria-filtered layers from the database || -
|}


=== Response ===

{| class="wikitable"
|-
! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
|-
| [Object Root] || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#006600">count</span> || number || - || YES || - || Total amount of layers to be displayed (according to filter parameter) || -
|-
| [Object Root].<span style="color:#006600">list</span> || object array || - || YES || - || - || To describe a generic object element of the array, the reference to its root is "list[]"
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> || number || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> || string || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">layer</span> || number || - || YES || - || PK of the layer object || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">branch</span> || string || - || YES || - || The branch name of the layer || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">commit</span> || string || - || YES || - || The current commit of the layer || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">priority</span> || number || - || NO || - || Priority of the layer || Known issues: [https://bugzilla.yoctoproject.org/show_bug.cgi?id=5218 5218]
|-
|}

== Task ==

Each build consists of a series of tasks. This is the endpoint for searching the task table.

=== Endpoints ===

{| class="wikitable"
|-
! Method !! Endpoint !! Body !! Description !! Comments
|-
| GET || /api/1.0/tasks || JSON || Returns page size-limited and search criteria-filtered tasks from the database || -
|}

=== Response ===

{| class="wikitable"
|-
! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
|-
| [Object Root] || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#006600">count</span> || number || - || YES || - || Total amount of tasks to be displayed (according to filter parameter) || -
|-
| [Object Root].<span style="color:#006600">list</span> || object array || - || YES || - || - || To describe a generic object element of the array, the reference to its root is "list[]"
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> || number || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> || string || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">build</span> || number || - || YES || - || Identifies the build in which the task occurred || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">order</span> || number || - || YES || - || The sequence ID of the task in launch order || 
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">task_executed</span> || boolean || - || YES || - || True if task actually executed || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">outcome</span> || number || 6 || YES || 6 || 0 Executed successfully <br/> 1 Covered by another task <br/> 2 Restored from sstate <br/> 3 Artifacts already existing <br/> 4 Fail during execution <br/> 5 Not available <br/> || Known issues: [http://bugzilla.yoctoproject.org/show_bug.cgi?id=5216 5216]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">sstate_checksum</span> || string || - || YES || - || Sstate checksum of the task || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">path_to_sstate_obj</span> || string || - || NO || - || The path to the sstate file, if applicable || Known issues: [http://bugzilla.yoctoproject.org/show_bug.cgi?id=5252 5252]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">recipe</span> || number || - || YES || - || ID of the recipe generating the task || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">task_name</span> || string || - || YES || - || Name of the task || e.g. "do_fetch"
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">source_url</span> || string || - || NO || - || Path to script source file (yes, it's misnamed) || Known issues: [http://bugzilla.yoctoproject.org/show_bug.cgi?id=5255 5255]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">logfile</span> || string || - || YES || - || Path to log file || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">work_directory</span> || string || - || YES || - || Cwd during task execution || Known issues: [http://bugzilla.yoctoproject.org/show_bug.cgi?id=5253 5253]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">script_type</span> || number || 3 || NO || 0 || See if we executed a shell or python script, or no script was executed || 0 noexec <br/> 1 python <br/> 2 shell <br />Known issues: [https://bugzilla.yoctoproject.org/show_bug.cgi?id=5327 5327]
|- 
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">line_number</span> || number || - || NO || - || Starting number of the line in the source file || Known issues: [http://bugzilla.yoctoproject.org/show_bug.cgi?id=5254 5254]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">disk_io</span> || number || - || NO || - || Time spent by the task in I/O operations (in ms) || Known issues: [https://bugzilla.yoctoproject.org/show_bug.cgi?id=5073 5073], [https://bugzilla.yoctoproject.org/show_bug.cgi?id=5485 5485]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">cpu_usage</span> || number || - || NO || - || Percent of the CPU used during the task || Known issues: [https://bugzilla.yoctoproject.org/show_bug.cgi?id=5073 5073], [https://bugzilla.yoctoproject.org/show_bug.cgi?id=5485 5485]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">sstate_result</span> || number || 4 || NO || 0 || Outcome of the sstate task || 0 N/A <br/> 1 Missing <br/> 2 Failed <br/> 3 Restored successfully <br/> Known issues: [http://bugzilla.yoctoproject.org/show_bug.cgi?id=5220 5220]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">message</span>.<span style="color:#006600">message</span> || string || - || NO || - || Any message from the system regarding the task || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">message</span>.<span style="color:#006600">elapsed_time</span> || string || - || NO || - || Time taken by the task to complete (in seconds) || Known issues: [https://bugzilla.yoctoproject.org/show_bug.cgi?id=5300 5300]
|}

== Task dependencies ==

Returns the tasks dependency data.

=== Endpoints ===

{| class="wikitable"
|-
! Method !! Endpoint !! Body !! Description !! Comments
|-
| GET || /api/1.0/task_dependencies || JSON || Returns page size-limited and search criteria-filtered tasks from the database || -
|}

=== Response ===

{| class="wikitable"
|-
! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
|-
| [Object Root] || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#006600">count</span> || number || - || YES || - || Total amount of tasks to be displayed (according to filter parameter) || -
|-
| [Object Root].<span style="color:#006600">list</span> || object array || - || YES || - || - || To describe a generic object element of the array, the reference to its root is "list[]"
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> || number || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> || string || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">task</span> || number || - || YES || - || The PK of the target task || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">depends_on</span> || number || - || YES || - || The PK of the task that the target task depends on  || -
|-
|}

== Recipe ==

Returns information about recipes in a certain build.

=== Endpoints ===

{| class="wikitable"
|-
! Method !! Endpoint !! Body !! Description !! Comments
|-
| GET || /api/1.0/recipes || JSON || Returns page size-limited and search criteria-filtered recipes from the database || -
|}

=== Response ===

{| class="wikitable"
|-
! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
|-
| [Object Root] || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#006600">count</span> || number || - || YES || - || Total amount of recipes to be displayed (according to filter parameter) || -
|-
| [Object Root].<span style="color:#006600">list</span> || object array || - || YES || - || - || To describe a generic object element of the array, the reference to its root is "list[]"
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> || number || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> || string || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">name</span> || string || - || YES || - || The recipe name || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">version</span> || string || - || YES || - || The recipe version || Known issues: [https://bugzilla.yoctoproject.org/show_bug.cgi?id=5459 5459]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">layer_version</span> || number || - || YES || - || The version of the layer in which the recipe existed at the task building time || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">summary</span> || string || - || YES || - || The content of the SUMMARY variable || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">description</span> || string || - || YES || - || The content of the DESCRIPTION variable || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">section</span> || string || - || YES || - || The section to which the recipe belongs || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">license</span> || string || - || YES || - || The license of the recipe || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">licensing_info</span> || string || - || YES || - || The directory containing the recipe license files || Known issues: [https://bugzilla.yoctoproject.org/show_bug.cgi?id=5194 5194]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">homepage</span> || string || - || YES || - || The website for the software provided by the recipe || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">bugtracker</span> || string || - || YES || - || The bug tracking website for the software provided by the recipe || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">author</span> || string || - || YES || - || The author of the recipe || Know issues: [https://bugzilla.yoctoproject.org/show_bug.cgi?id=5449 5449]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">file_path</span> || string || - || YES || - || Path to the recipe .bb file || -
|-
|}

== Recipe dependencies ==

Returns the recipe dependency data.

=== Endpoints ===

{| class="wikitable"
|-
! Method !! Endpoint !! Body !! Description !! Comments
|-
| GET || /api/1.0/recipe_dependencies || JSON || Returns page size-limited and search criteria-filtered recipes from the database || -
|}

=== Response ===

{| class="wikitable"
|-
! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
|-
| [Object Root] || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#006600">count</span> || number || - || YES || - || Total amount of recipes to be displayed (according to filter parameter) || -
|-
| [Object Root].<span style="color:#006600">list</span> || object array || - || YES || - || - || To describe a generic object element of the array, the reference to its root is "list[]"
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> || number || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> || string || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">recipe</span> || number || - || YES || - || The PK of the target recipe || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">depends_on</span> || number || - || YES || - || The PK of the recipe that the target recipe depends on  || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">dep_type</span> || number || 2 || YES || - || Dependency type || 0 [http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#var-DEPENDS DEPENDS] <br /> 1 [http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#var-RDEPENDS RDEPENDS] 
|-
|}

== Build packages ==

Returns data about packages built. This information is collected at build time, while [[#Target installed packages | target installed packages]] information is collected from [http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#maintaining-build-output-quality build history].

Known issues: [https://bugzilla.yoctoproject.org/show_bug.cgi?id=5269 5269]

=== Endpoints ===

{| class="wikitable"
|-
! Method !! Endpoint !! Body !! Description !! Comments
|-
| GET || /api/1.0/packages || JSON || Returns page size-limited and search criteria-filtered packages from the database || -
|}

=== Response ===

{| class="wikitable"
|-
! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
|-
| [Object Root] || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#006600">count</span> || number || - || YES || - || Total amount of packages to be displayed (according to filter parameter) || -
|-
| [Object Root].<span style="color:#006600">list</span> || object array || - || YES || - || - || To describe a generic object element of the array, the reference to its root is "list[]"
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> || number || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> || string || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">build</span> || number || - || YES || - || The PK of the build that generated this package || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">recipe</span> || number || - || YES || - || The PK of the recipe that generated this package || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">name</span> || string || - || YES || - || The package name || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">version</span> || string || - || YES || - || The package version || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">revision</span> || string || - || YES || - || The package revision || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">size</span> || number || - || YES || - || The size of the package, in kilobytes || Known issues: [https://bugzilla.yoctoproject.org/show_bug.cgi?id=5503 5503]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">section</span> || string || - || YES || - || The section to which this package belongs || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">license</span> || string || - || YES || - || The license of the package || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">summary</span> || string || - || YES || - || The content of the recipe SUMMARY || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">description</span> || string || - || YES || - || The content of the recipe DESCRIPTION || -
|-
|}

== Package dependencies ==

Returns the package dependency data.

Known issues: [https://bugzilla.yoctoproject.org/show_bug.cgi?id=5269 5269]

=== Endpoints ===

{| class="wikitable"
|-
! Method !! Endpoint !! Body !! Description !! Comments
|-
| GET || /api/1.0/package_dependencies || JSON || Returns page size-limited and search criteria-filtered packages from the database || -
|}


=== Response ===

{| class="wikitable"
|-
! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
|-
| [Object Root] || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#006600">count</span> || number || - || YES || - || Total amount of packages to be displayed (according to filter parameter) || -
|-
| [Object Root].<span style="color:#006600">list</span> || object array || - || YES || - || - || To describe a generic object element of the array, the reference to its root is "list[]"
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> || number || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> || string || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">package</span> || number || - || YES || - || The PK of the target package || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">depends_on</span> || number || - || YES || - || The PK of the package that the target package depends on  || Known issues: [http://bugzilla.yoctoproject.org/show_bug.cgi?id=5225  5225]
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">dep_type</span> || number || 6 || YES || - || Dependency type || 0 [http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#var-RDEPENDS RDEPENDS] <br/> 1 [http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#var-RPROVIDES RPROVIDES] <br/> 2 [http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#var-RRECOMMENDS RRECOMMENDS] <br/> 5 [http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#var-RSUGGESTS RSUGGESTS] <br/> 4 [http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#var-RREPLACES RREPLACES] <br /> 5 [http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#var-RCONFLICTS RCONFLICTS] <br />
|-
|}

== Package files ==

Returns data about package-generated files.

Known issues: [https://bugzilla.yoctoproject.org/show_bug.cgi?id=5269 5269]

=== Endpoints ===

{| class="wikitable"
|-
! Method !! Endpoint !! Body !! Description !! Comments
|-
| GET || /api/1.0/package_files || JSON || Returns page size-limited and search criteria-filtered files for a package from the database || -
|}


=== Response ===

{| class="wikitable"
|-
! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
|-
| [Object Root] || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#006600">count</span> || number || - || YES || - || Total amount of files to be displayed (according to filter parameter) || -
|-
| [Object Root].<span style="color:#006600">list</span> || object array || - || YES || - || - || To describe a generic object element of the array, the reference to its root is "list[]"
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> || number || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> || string || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">bpackage</span> || number || - || YES || - || The PK of the package generating the file || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">path</span> || String || - || YES || - || Full file path  || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">size</span> || number || - || YES || - || File size, in bytes || -
|-
|}

== Variables ==

Returns data about key-value pairs applied to a certain build.

=== Endpoints ===

{| class="wikitable"
|-
! Method !! Endpoint !! Body !! Description !! Comments
|-
| GET || /api/1.0/variables || JSON || Returns page size-limited and search criteria-filtered variables from the database || -
|}

=== Response ===

{| class="wikitable"
|-
! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
|-
| [Object Root] || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#006600">count</span> || number || - || YES || - || Total amount of variables to be displayed (according to filter parameter) || -
|-
| [Object Root].<span style="color:#006600">list</span> || object array || - || YES || - || - || To describe a generic object element of the array, the reference to its root is "list[]"
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> || number || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> || string || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">build</span> || number || - || YES || - || The PK of the build that generated this variable || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">variable_name</span> || string || - || YES || - || The key in a key-value pair || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">variable_value</span> || string || - || YES || - || The value in a key-value pair || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">changed</span> || boolean || - || YES || - || Not defined  || Not currently available
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">human_readable_name</span> || string || - || YES || - || Not defined  || Not currently available
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">description</span> || string || - || YES || - || Variable description in documentation.conf  || -
|-
|}



== Variable History ==

Returns information on how the variable reached its current value. 

=== Endpoints ===

{| class="wikitable"
|-
! Method !! Endpoint !! Body !! Description !! Comments
|-
| GET || /api/1.0/variablehistory || JSON || Returns page size-limited and search criteria-filtered variables from the database || -
|}

=== Response ===

{| class="wikitable"
|-
! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
|-
| [Object Root] || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#006600">count</span> || number || - || YES || - || Total amount of entries to be displayed (according to filter parameter) || -
|-
| [Object Root].<span style="color:#006600">list</span> || object array || - || YES || - || - || To describe a generic object element of the array, the reference to its root is "list[]"
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> || number || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> || string || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">variable</span> || number || - || YES || - || The PK of the variable this operation changed || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">file_name</span> || string || - || YES || - || The file name where the variable value change was specified || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">line_number</span> || integer || - || YES || - || The line number in the file where the variable value change was specified || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">operation</span> || string || - || YES || - || The change that took place, uninterpreted value  || -
|-
|}


== Log messages ==

Returns data about errors / warnings thrown by the build.

=== Endpoints ===

{| class="wikitable"
|-
! Method !! Endpoint !! Body !! Description !! Comments
|-
| GET || /api/1.0/logmessages || JSON || Returns page size-limited and search criteria-filtered messages from the database || -
|}


=== Response ===

{| class="wikitable"
|-
! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
|-
| [Object Root] || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#006600">count</span> || number || - || YES || - || Total amount of messages to be displayed (according to filter parameter) || -
|-
| [Object Root].<span style="color:#006600">list</span> || object array || - || YES || - || - || To describe a generic object element of the array, the reference to its root is "list[]"
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> || number || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> || string || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> || object || - || YES || - || - || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">build</span> || number || - || YES || - || The PK of the build that generated this message || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">level</span> || number || 3 || YES || - || Message type ||  0 - INFO<br/> 1 - WARNING<br/> 2 - ERROR<br/>
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">message</span> || string || - || YES || - || The message content || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">pathname</span> || string || - || YES || - || Path to the file generating the message  || -
|-
| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">lineno</span> || number || - || YES || - || Line number generating the message || -
|-
|}