Testkube OpenAPI Definitions

Testkube exposes two REST APIs that can be consumed accordingly:

• The Runner API exposed by the Standalone Runner
• The Control Plane API exposed by the Testkube Control-Plane (both cloud and on-prem)

tip

The OpenAPI definitions for these APIs are available at

• Standalone Runner OpenAPI
• Control Plane OpenAPI

Runner API

The Runner API provides programmatic access to most features exposed by the Runner itself when it is running in standalone mode. This is the same API used by the Testkube CLI for most of its commands.

By default, this API does not require any authentication for any of its operations - so be careful in giving access.

Control Plane API

The Control Plane API provides programmatic access to features both specific the control-plane itself, and acts as a proxy for making authenticated calls to connected Runners.

The operations exposed by the control plane are here divided into the following categories:

• Core Operations: High-level control plane operations.
• Agent Operations: Proxied Runner operations for a specific environment. These match the Runner API operations, but with organization and environment identifiers. The reference still labels this group Agent Operations.
• Organization Operations: Operations for a specific organization defined in the Control Plane.
• Environment Operations: Operations for a specific environment defined within an organization.

These API calls all require an API token specified using Bearer Token authentication.

• API Tokens can be created as described at Organization Management.
• Add an Authorization HTTP header to your API requests with the value Bearer: <API token>