---
title: "Pass input parameters and request a plan of tests to be run."
method: POST
path: "/request"
tags: ["request"]
---

# Pass input parameters and request a plan of tests to be run.

`POST /request`

Pass details about a test plan and request for it to be run.
The api will validate all input parameters and return a status code,
as well as a url to track the status of the job, if accepted.

## Query parameters

- `test_artifact_url` string, uri
- `tests_repo` string — Url to git repository containing tests and test plans.
- `tests_repo_branch` string — Branch of test_repo to use.
- `tests_plans` TestPlanPath[], required — List of paths to plan.yaml files detailing test plans.
- `testbed` string, required — Url to image to be used as testbed. Has to be either .iso or .img format. Can also be a shortform, e.g. ubuntu:questing:daily, which'll expand to an appropriate url for official Ubuntu images.
- `debug` boolean — Enable debug artifacts.
- `priority` integer — Priority of test request. Jobs with higher priority get processed before jobs with lower priority. Requesters have assigned maximum priority levels. A request with a priority level higher than the requesters assigned maximum priority level are demoted to said level.

## Response `201`

JSON returned after successful test request

- object
  - `uuid` string — UUID to identify a job.
  - `job_url` string, uri — URL to track the status of a job.

## Other responses

- `400` — Returned when input fields are incorrect.
- `401` — Returned when the requester doesn't have privileges to request a test.
- `404` — Returned when the tests repo, test plans, or image url doesn't exist.
- `405` — Returned when the requester tries a method other than POST.
- `415` — Returned when the requester requests a test with an unsupported image type.
- `500` — Internal server error

---

[API](https://skmtc.net/canonical/apis/guts-api-spec.md) · [All operations](https://skmtc.net/canonical/apis/guts-api-spec/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/canonical/guts-api-spec/versions/8b8b30aae61c/schema)