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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Kubeshop

Kubeshop tests API

Tests operations

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 17 operations across 11 paths, and defines 35 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 35 schemas 2 DELETE8 GET2 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
1

Paths & Operations 17

Across 11 paths, the API surfaces 17 operations — 2 DELETE, 8 GET, 2 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

tests 17

Tests operations

GET
/test-suites/{id}/metrics
Get test suite metrics
getTestSuiteMetrics 3 params → 200500
POST
/executions
Starts new test executions
executeTests 4 params body → 201400404502500
GET
/tests
List tests
listTests 2 params → 200400502
POST
/tests
Create new test
createTest body → 200201400502
DELETE
/tests
Delete tests
deleteTests 1 param → 204404500502
PATCH
/tests/{id}
Update test
updateTest 1 param body → 200400404502
GET
/tests/{id}
Get test
getTest 1 param → 200400404502
DELETE
/tests/{id}
Delete test
deleteTest 3 params → 204404500502
POST
/tests/{id}/abort
Abort all executions of a test
abortTestExecutions 1 param → 204404500502
GET
/tests/{id}/metrics
Get test metrics
getTestMetrics 3 params → 200500502
GET
/test-with-executions
List test with executions
listTestWithExecutions 5 params → 200400500502
GET
/test-with-executions/{id}
Get test with execution
getTestWithExecution 1 param → 200400404500502
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

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are ExecutionRequest (49 properties), Execution (38 properties), Test (13 properties), ExecutionSummary (13 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
TestUpdateRequest
object
test update request body
TestStatus
object
test status
1 property
ArtifactRequest
object
artifact request body with test artifacts
9 properties
TestUpsertRequest
object
test create request body
Variables
object
execution variables passed to executor converted to vars for usage in tests
ExecutionCore
object
test execution core
5 properties
ExecutionsTotals
object
various execution counters
5 properties 6 required
PodRequest
object
pod request body
3 properties
ExecutionsMetrics
object
12 properties
ConfigMapRef
object
Testkube internal reference for data in Kubernetes config maps
3 properties 2 required
Test
object
13 properties
ExecutionsMetricsExecutions
object
8 properties
ResourceRequest
object
resource request specification
2 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
RepositoryParameters
object
repository parameters for tests in git repositories
4 properties
Repository
object
repository representation for tests in git repositories
12 properties 2 required
ExecutionRequest
object
test execution request body
49 properties
ExecutionSummary
object
Execution summary
13 properties 5 required
ExecutionsResult
object
the result for a page of executions
3 properties 2 required
TestContent
object
4 properties
TestWithExecutionSummary
object
Test with latest Execution result summary
2 properties 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
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
TestWithExecution
object
Test with latest Execution result
2 properties 1 required
VariableType
string
Execution
object
test execution
38 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubeshop-tests-api-openapi.yml Raw ↑

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 Executions 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
#tests
← Back to K APIs
API Details
ID
kubeshop:kubeshop-tests-api
Base URL
https://api.testkube.io
Docs
https://docs.testkube.io/openapi/overview
Provider
Kubeshop
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network