Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qase runs API

Test runs - executions of selected test cases in a project.

Qase runs API is one of 7 APIs that Qase publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include runs. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 7 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.qase.io/v1.

7 operations 4 paths 8 schemas 1 DELETE2 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.qase.io/v1
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Qase runs API declares 1 security scheme for authenticating requests. An API key is passed in the header as Token (TokenAuth). By default, every request must be authenticated.

  • TokenAuth — A personal or application API token. Create it in the Qase app under Settings and pass it in the Token header on every request. All requests must use HTTPS.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

runs 7

Test runs - executions of selected test cases in a project.

GET
/run/{code}
Get all test runs
get-runs 9 params → 200401429
POST
/run/{code}
Create a new test run
create-run 1 param body → 200401422429
GET
/run/{code}/{id}
Get a specific test run
get-run 2 params → 200401404429
PATCH
/run/{code}/{id}
Update a specific test run
update-run 2 params body → 200401404429
DELETE
/run/{code}/{id}
Delete a specific test run
delete-run 2 params → 200401404429
POST
/run/{code}/{id}/complete
Complete a specific test run
complete-run 2 params → 200401404429
PATCH
/run/{code}/{id}/public
Update a test run publicity
update-run-publicity 2 params body → 200401404429

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Run (9 properties), RunCreate (7 properties), Error (3 properties), RunListResponse (2 properties). Each schema is shown below with its type and property counts.

RunResponse
object
2 properties
RunUpdate
object
2 properties
RunCreate
object
7 properties 1 required
RunListResponse
object
2 properties
Run
object
9 properties
IdResponse
object
2 properties
BaseResponse
object
1 property
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qase-runs-api-openapi.yml Raw ↑

Other APIs Qase publishes across the network.

Qase cases API
Qase defects API
Qase plans API
Qase projects API
Qase results API
Qase suites API