Kubeshop test-suites API
Test suites orchestration operations
Kubeshop test-suites API is one of 30 APIs that Kubeshop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include test-suites. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 17 operations across 11 paths, and defines 54 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://.
17 operations
11 paths
54 schemas
2 DELETE9 GET2 PATCH4 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 17
Across 11 paths, the API surfaces 17 operations — 2 DELETE, 9 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.
test-suites 17
Test suites orchestration operations
POST
/test-suites
Create new test suite
GET
/test-suites
Get all test suites
DELETE
/test-suites
Delete test suites
GET
/test-suites/{id}
Get test suite by ID
PATCH
/test-suites/{id}
Update test suite
DELETE
/test-suites/{id}
Delete test suite
GET
/test-suites/{id}/tests
List tests for test suite
POST
/test-suites/{id}/abort
Abort all executions of a test suite
GET
/test-suite-with-executions
Get all test suite with executions
GET
/test-suite-with-executions/{id}
Get test suite by ID with execution
POST
/test-suites/{id}/executions
Starts new test suite execution
GET
/test-suites/{id}/executions
Get all test suite executions
GET
/test-suites/{id}/executions/{executionID}
Get test suite execution
PATCH
/test-suites/{id}/executions/{executionID}
Aborts testsuite execution
GET
/test-suites/{id}/executions/{executionID}/artifacts
Get test suite execution artifacts
POST
/test-suite-executions
Starts new test suite executions
GET
/test-suite-executions/{executionID}/artifacts
Get test suite execution artifacts
Schemas 54
The contract defines 54 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
TestSuiteUpsertRequest
object
test suite create request body
2 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
TestSuiteWithExecution
object
Test suite with latest execution result
2 properties
1 required
TestStatus
object
test status
1 property
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
Test
object
13 properties
ExecutionCore
object
test execution core
5 properties
TestSuiteExecutionRequest
object
test suite execution request body
24 properties
TestSuiteStepExecutionRequest
object
test step execution request body
19 properties
ResourceRequest
object
resource request specification
2 properties
TestSuiteBatchStepExecutionResult
object
execution result returned from executor
5 properties
ExecutionStatus
string
TestContentRequest
object
test content request body
1 property
TestSuiteStatus
object
test suite status
1 property
Variable
object
5 properties
PodResourcesRequest
object
pod resources request specification
2 properties
LocalObjectReference
object
Reference to Kubernetes object
1 property
RepositoryParameters
object
repository parameters for tests in git repositories
4 properties
TestSuite
object
13 properties
2 required
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
ExecutionRequest
object
test execution request body
49 properties
TestSuiteStepV2
object
3 properties
3 required
TestSuiteStepType
string
TestContent
object
4 properties
TestSuiteExecutionStatus
string
TestSuiteStepDelayV2
object
1 property
1 required
Problem
object
problem response in case of error
5 properties
ExecutionResult
object
execution result returned from executor
6 properties
1 required
TestSuiteBatchStep
object
set of steps run in parallel
3 properties
1 required
ObjectRef
object
2 properties
1 required
AssertionResult
object
execution result data
3 properties
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
TestSuiteExecutionCore
object
test suite execution core
4 properties
TestSuiteWithExecutionSummary
object
Test suite with latest execution result
2 properties
1 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
TestSuiteUpdateRequest
object
test suite update body
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kubeshop 12
Other APIs Kubeshop publishes across the network.
Kubeshop api API
Kubeshop artifacts API
Kubeshop cluster-resources API
Kubeshop Executions API
Kubeshop executor API
Kubeshop keymap API
Kubeshop labels API
Kubeshop logs API
Kubeshop Organizations API
Kubeshop pro API
Kubeshop repository API
Kubeshop secrets API
#test-suites