boot

More info about the boot schema can be found here.

Note

This resource can also be accessed using the plural form boots.

GET

GET /boot/(string: id)/

Get all the available boot reports or a single one if id is provided.

Parameters:
  • id (string) – The ID of the boot report to retrieve.
Request Headers:
 
Response Headers:
 
Query Parameters:
 
  • limit (int) – Number of results to return. Default 0 (all results).
  • skip (int) – Number of results to skip. Default 0 (none).
  • sort (string) – Field to sort the results on. Can be repeated multiple times.
  • sort_order (int) – The sort order of the results: -1 (descending), 1 (ascending). This will be applied only to the first sort parameter passed. Defaults to -1.
  • date_range (int) – Number of days to consider, starting from today (more info). By default consider all results.
  • field (string) – The field that should be returned in the response. Can be repeated multiple times.
  • nfield (string) – The field that should not be returned in the response. Can be repeated multiple times.
  • _id (string) – The internal ID of the boot report.
  • board (string) – The name of a board.
  • created_on (string) – The creation date: accepted formats are YYYY-MM-DD and YYYYMMDD.
  • build_id (string) – The ID of a build document.
  • defconfig (string) – The name of a defconfig.
  • defconfig_full (string) – The full name of a defconfig (with config fragments).
  • endian (string) – The endianness of the board.
  • job (string) – The name of a job.
  • job_id (string) – The ID of a job.
  • kernel (string) – The name of a kernel.
  • lab_name (string) – The name of the lab that created the boot report.
  • mach (string) – The machine type.
  • retries (int) – The number of boot retries performed.
  • status (string) – The status of the boot report.
  • warnings (int) – The number of warnings in the boot report.
  • time_range (string) – Minutes of data to consider, in UTC time (more info). Minimum value is 10 minutes, maximum is 60 * 24.
Status Codes:

Example Requests

GET /boot/ HTTP/1.1
Host: api.kernelci.org
Accept: */*
Authorization: token
GET /boot/012345678901234567890123/ HTTP/1.1
Host: api.kernelci.org
Accept: */*
Authorization: token
GET /boot?job=next&kernel=next-20140905&field=status&field=defconfig&nfield=_id HTTP/1.1
Host: api.kernelci.org
Accept: */*
Authorization: token

Example Responses

HTTP/1.1 200 OK
Vary: Accept-Encoding
Date: Mon, 08 Sep 2014 12:28:50 GMT
Content-Type: application/json; charset=UTF-8

{
    "code": 200,
    "result": [
        {
            "status": "PASS",
            "kernel": "next-20140905",
            "job": "next",
            "_id": "012345678901234567890123",
            "fastboot": false,
            "warnings": 0,
            "defconfig": "arm-omap2plus_defconfig"
        },
    ],
}
HTTP/1.1 200 OK
Vary: Accept-Encoding
Date: Mon, 08 Sep 2014 12:32:50 GMT
Content-Type: application/json; charset=UTF-8

{
    "code": 200,
    "count": 78,
    "limit": 0,
    "result": [
        {
            "status": "PASS",
            "defconfig": "arm-multi_v7_defconfig"
        },
        {
            "status": "PASS",
            "defconfig": "arm-multi_v7_defconfig"
        },
        {
            "status": "PASS",
            "defconfig": "arm-multi_v7_defconfig+CONFIG_ARM_LPAE=y"
        }
    ],
}

Note

Results shown here do not include the full JSON response.

GET /boot/distinct/(string: field)/

Get all the unique values for the specified field. Accepted field values are:

  • arch
  • board_instance
  • board
  • defconfig_full
  • defconfig
  • endian
  • git_branch
  • git_commit
  • git_describe
  • git_url
  • job
  • kernel
  • lab_name
  • mach

The query parameters can be used to first filter the data on which the unique value should be retrieved.

Parameters:
  • field (string) – The name of the field to get the unique values of.
Request Headers:
 
Response Headers:
 
Query Parameters:
 
  • limit (int) – Number of results to return. Default 0 (all results).
  • skip (int) – Number of results to skip. Default 0 (none).
  • sort (string) – Field to sort the results on. Can be repeated multiple times.
  • sort_order (int) – The sort order of the results: -1 (descending), 1 (ascending). This will be applied only to the first sort parameter passed. Default -1.
  • date_range (int) – Number of days to consider, starting from today (more info). By default consider all results.
  • field (string) – The field that should be returned in the response. Can be repeated multiple times.
  • nfield (string) – The field that should not be returned in the response. Can be repeated multiple times.
  • _id (string) – The internal ID of the boot report.
  • created_on (string) – The creation date: accepted formats are YYYY-MM-DD and YYYYMMDD.
  • job (string) – A job name.
  • kernel (string) – A kernel name.
  • status (string) – The status of the job report.
Status Codes:

Example Requests

GET /boot/distinct/mach HTTP/1.1
Host: api.kernelci.org
Accept: */*
Authorization: token
GET /boot/distinct/board?mach=tegra HTTP/1.1
Host: api.kernelci.org
Accept: */*
Authorization: token

Example Responses

HTTP/1.1 200 OK
Vary: Accept-Encoding
Date: Fri, 20 Nov 2015 15:12:50 GMT
Content-Type: application/json; charset=UTF-8

{
    "code": 200,
    "count:" 29,
    "result": [
        "alpine",
        "apm",
        "arm"
    ]
}
HTTP/1.1 200 OK
Vary: Accept-Encoding
Date: Mon, 11 Aug 2014 15:23:00 GMT
Content-Type: application/json; charset=UTF-8

{
    "code": 200,
    "count": 7,
    "result": [
        "tegra124-jetson-tk1",
        "tegra124-jetson-tk1_rootfs:nfs",
        "tegra124-nyan-big"
    ]
}

Note

Results shown here do not include the full JSON response.

GET /boot/regressions/

Get the registered boot regressions.

More info about the boot regressions schema can be found here.

Request Headers:
 
Response Headers:
 
Query Parameters:
 
  • field (string) – The field that should be returned in the response. Can be repeated multiple times.
  • nfield (string) – The field that should not be returned in the response. Can be repeated multiple times.
  • _id (string) – The internal ID of the registered boot regression.
  • created_on (string) – The creation date: accepted formats are YYYY-MM-DD and YYYYMMDD.
  • job (string) – The name of the job.
  • kernel (string) – The name of the kernel.
  • job_id (string) – The ID of the job.
Status Codes:

Example Requests

GET /boot/regressions?job=next&kernel=next-20160705 HTTP/1.1
Host: api.kernelci.org
Accept: */*
Authorization: token
GET /boot/regressions?job_id=12345678901234567890ABCD HTTP/1.1
Host: api.kernelci.org
Accept: */*
Authorization: token
GET /boot/(string: id)/regressions/

Get the registered regressions for the specified boot report.

This will only return the array with the boot reports that have been tracked in the regression.

More info about the boot regressions schema can be found here.

Parameters:
  • id (string) – The ID of the boot report.
Request Headers:
 
Response Headers:
 
Status Codes:

Example Requests

GET /boot/12345678901234567890ABCD/regressions/ HTTP/1.1
Host: api.kernelci.org
Accept: */*
Authorization: token

Example Responses

HTTP/1.1 200 OK
Vary: Accept-Encoding
Date: Tue, 05 Jul 2016 15:12:50 GMT
Content-Type: application/json; charset=UTF-8

{
    "code": 200,
    "count:" 2,
    "result": [
        {
            "_id": {
                "$oid": "12345678901234567890ABCC"
            },
            "status": "PASS"
        },
        {
            "_id": {
                "$oid": "12345678901234567890ABCD"
            },
            "status": "FAIL"
        }
    ]
}

Note

Results shown here do not include the full JSON response.

POST

POST /boot

Create or update a boot report as defined in the JSON data. The request will be accepted and it will begin to parse the available data.

If the request has been accepted, it will always return 202 as the status code.

For more info on all the required JSON request fields, see the boot schema for POST requests.

Request JSON Object:
 
  • arch (string) – The architecture of the board.
  • board (string) – The name of the board.
  • defconfig (string) – The name of the defconfig.
  • job (string) – The name of the job.
  • git_branch (string) – The name of the branch.
  • kernel (string) – The name of the kernel.
  • lab_name (string) – The name of the boot tests lab.
  • version (string) – The version number of the schema.
Request Headers:
 
Response Headers:
 
Status Codes:

Example Requests

POST /boot HTTP/1.1
Host: api.kernelci.org
Content-Type: application/json
Accept: */*
Authorization: token

{
    "job": "next",
    "kernel": "next-20140801",
    "defconfig": "all-noconfig",
    "lab_name": "lab-01",
    "board": "beagleboneblack",
    "git_branch": "master"
}

DELETE

DELETE /boot/(string: id)/

Delete the boot report identified by id.

Parameters:
  • id (string) – The ID of the boot report to delete.
Request Headers:
 
Response Headers:
 
Query Parameters:
 
  • _id (string) – The ID of a boot report.
  • board (string) – The name of a board.
  • defconfig (string) – The name of a defconfig.
  • defconfig_full (string) – The full name of a defconfig (with config fragments).
  • build_id (string) – The ID of a build document.
  • job (string) – The name of a job.
  • job_id (string) – The ID of a job.
  • kernel (string) – The name of a kernel.
  • name (string) – The name of a boot report.
Status Codes:

Example Requests

DELETE /boot/01234567890123456789ABCD HTTP/1.1
Host: api.kernelci.org
Accept: */*
Content-Type: application/json
Authorization: token
DELETE /boot?job=mainline&board=legacy,omap3-n900 HTTP/1.1
Host: api.kernelci.org
Accept: */*
Content-Type: application/json
Authorization: token