Kubeshop Executions API

The Executions API from Kubeshop — 19 operation(s) for executions.

Documentation Provider Profile APIs.io OpenAPI GitHub

Kubeshop Executions API is one of 30 APIs that Kubeshop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 26 operations across 19 paths, and defines 49 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against 2 base URLs: https://api.testkube.io, https://.

26 operations 19 paths 49 schemas 18 GET3 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.1

API Version

1.0.0

Base URL

https://api.testkube.io

Contact

info@testkube.io

License

MIT

Resource Areas

Paths & Operations 26

Across 19 paths, the API surfaces 26 operations — 18 GET, 3 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Executions 26

POST

/executions

Starts new test executions

executeTests 4 params body → 201400404500502

GET

/executions

Get all test executions

listExecutions 9 params → 200404500

GET

/executions/{executionID}

Get test execution by ID

getExecutionByID 1 param → 200404500502

GET

/executions/{id}/artifacts

Get execution's artifacts by ID

getExecutionArtifacts 1 param → 200404500

GET

/executions/{id}/logs

Get execution's logs by ID

getExecutionLogs 1 param → 200500

GET

/executions/{id}/logs/v2

Get execution's logs by ID version 2

getExecutionLogsV2 1 param → 200500

GET

/executions/{id}/artifacts/{filename}

Download artifact

downloadFile 2 params → 200404500

GET

/executions/{id}/artifact-archive

Download artifact archive

downloadArchive 2 params → 200404500

POST

/test-suites/{id}/executions

Starts new test suite execution

executeTestSuite 4 params body → 201400404500502

GET

/test-suites/{id}/executions

Get all test suite executions

listTestSuiteExecutions 6 params → 200500

GET

/test-suites/{id}/executions/{executionID}

Get test suite execution

getTestSuiteExecution 2 params → 200404500502

PATCH

/test-suites/{id}/executions/{executionID}

Aborts testsuite execution

abortTestSuiteExecution 2 params → 204404500

GET

/test-suites/{id}/executions/{executionID}/artifacts

Get test suite execution artifacts

getTestSuiteExecutionArtifactsByTestsuite 2 params → 200404500

POST

/test-suite-executions

Starts new test suite executions

executeTestSuites 3 params body → 201400502500

GET

/test-suite-executions

Get all test suite executions

listAllTestSuiteExecutions 9 params → 200500

GET

/test-suite-executions/{executionID}

Get test suite execution by ID

getTestSuiteExecutionByID 2 params → 200500

PATCH

/test-suite-executions/{executionID}

Aborts testsuite execution

abortTestSuiteExecutionByID 1 param → 502204

GET

/test-suite-executions/{executionID}/artifacts

Get test suite execution artifacts

getTestSuiteExecutionArtifacts 1 param → 200500

POST

/tests/{id}/executions

Starts new test execution

executeTest 3 params body → 201400404502500

GET

/tests/{id}/executions

Get all test executions

listTestExecutions 7 params → 200404500

GET

/tests/{id}/executions/{executionID}

Get test execution

getTestExecution 2 params → 200404500502

PATCH

/tests/{id}/executions/{executionID}

Aborts execution

abortExecution 2 params → 204502

POST

/uploads

Upload file

uploads body → 200400500

GET

/test-workflow-executions/{executionID}/artifacts

Get test workflow execution's artifacts by ID

getTestWorkflowExecutionArtifacts 1 param → 200404402500

GET

/test-workflow-executions/{executionID}/artifacts/{filename}

Download test workflow artifact

downloadTestWorkflowArtifact 2 params → 200404402500

GET

/test-workflow-executions/{executionID}/artifact-archive

Download test workflow artifact archive

downloadTestWorkflowArtifactArchive 2 params → 200404402500

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are ExecutionRequest (49 properties), Execution (38 properties), TestSuiteExecutionRequest (24 properties), TestSuiteStepExecutionRequest (19 properties). Each schema is shown below with its type and property counts.

RunningContext

object

running context for test or test suite execution

2 properties 1 required

Artifact

object

API server artifact

4 properties

TestSuiteStepExecutionSummary

object

Test suite execution summary

5 properties 3 required

TestSuiteExecutionSummary

object

Test execution summary

10 properties 4 required

ArtifactRequest

object

artifact request body with test artifacts

9 properties

Variables

object

execution variables passed to executor converted to vars for usage in tests

ExecutionsTotals

object

various execution counters

5 properties 6 required

TestSuiteStepExecutionResultV2

object

execution result returned from executor

3 properties

PodRequest

object

pod request body

3 properties

DownloadArtifactOptions

object

options to download artifacts from previous steps

3 properties

ConfigMapRef

object

Testkube internal reference for data in Kubernetes config maps

3 properties 2 required

TestSuiteStepExecuteTestV2

TestSuiteStepExecutionRequest

object

test step execution request body

19 properties

TestSuiteExecutionRequest

object

test suite execution request body

24 properties

ResourceRequest

object

resource request specification

2 properties

LogV1

object

Log format version 1

1 property 1 required

TestSuiteBatchStepExecutionResult

object

execution result returned from executor

5 properties

ExecutionStatus

string

TestContentRequest

object

test content request body

1 property

Variable

object

5 properties

PodResourcesRequest

object

pod resources request specification

2 properties

LocalObjectReference

object

Reference to Kubernetes object

1 property

LogV2

object

Log format version 2

8 properties 2 required

ExecutorOutput

object

CRD based executor data

4 properties 1 required

RepositoryParameters

object

repository parameters for tests in git repositories

4 properties

TestSuiteBatchStepExecutionSummary

object

Test suite batch execution summary

1 property

TestSuiteExecution

object

Test suite executions data

17 properties 3 required

Repository

object

repository representation for tests in git repositories

12 properties 2 required

ExecutionSummary

object

Execution summary

13 properties 5 required

ExecutionRequest

object

test execution request body

49 properties

TestSuiteStepV2

object

3 properties 3 required

ExecutionsResult

object

the result for a page of executions

3 properties 2 required

TestSuiteStepType

string

TestContent

object

4 properties

TestSuiteExecutionStatus

string

TestSuiteStepDelayV2

object

1 property 1 required

ExecutionResult

object

execution result returned from executor

6 properties 1 required

AssertionResult

object

execution result data

3 properties

Problem

object

problem response in case of error

5 properties

TestSuiteBatchStep

object

set of steps run in parallel

3 properties 1 required

ObjectRef

object

2 properties 1 required

TestSuiteStepExecutionResult

object

execution result returned from executor

3 properties

ExecutionStepResult

object

execution result data

4 properties 2 required

SecretRef

object

Testkube internal reference for secret storage in Kubernetes secrets

3 properties 2 required

EnvReference

object

Reference to env resource

4 properties 1 required

TestSuiteExecutionsResult

object

the result for a page of executions

3 properties 2 required

TestSuiteStep

object

3 properties

VariableType

string

Execution

object

test execution

38 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Kubeshop publishes across the network.

Kubeshop api API

AE Profile APIs.io

Kubeshop artifacts API

AE Profile APIs.io

Kubeshop cluster-resources API

AE Profile APIs.io

Kubeshop executor API

AE Profile APIs.io

Kubeshop keymap API

AE Profile APIs.io

Kubeshop labels API

AE Profile APIs.io

Kubeshop logs API

AE Profile APIs.io

Kubeshop Organizations API

AE Profile APIs.io

Kubeshop pro API

AE Profile APIs.io

Kubeshop repository API

AE Profile APIs.io

Kubeshop secrets API

AE Profile APIs.io

Kubeshop Status Pages API

AE Profile APIs.io

#Executions

← Back to K APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Kubeshop Executions API

Metadata

Paths & Operations 26

Schemas 49

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Kubeshop Executions API

Metadata

Paths & Operations 26

Schemas 49

Specification

Source

More from Kubeshop 12

API Details

Provider

Explore more