How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kubeshop api API

Testkube API operations

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

The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 30 operations across 20 paths, and defines 198 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against the base URL https://api.testkube.io.

30 operations 20 paths 198 schemas 5 DELETE15 GET4 PATCH6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.testkube.io
License
Resource Areas
1

Paths & Operations 30

Across 20 paths, the API surfaces 30 operations — 5 DELETE, 15 GET, 4 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

api 30

Testkube API operations

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
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
/executions
Starts new test executions
executeTests 4 params body → 201400404502500
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
DELETE
/executors/{id}
Delete executor
deleteExecutor 1 param → 204502
GET
/executors/{id}
Get executor details
getExecutor 1 param → 200400502500
GET
/executor-by-types
Get executor details by type
getExecutorByType 1 param → 200400502500
DELETE
/webhooks/{id}
Delete webhook
deleteWebhook 1 param → 204404502
GET
/webhooks/{id}
Get webhook details
getWebhook 1 param → 200400404500502
DELETE
/webhook-templates/{id}
Delete webhook template
deleteWebhookTemplate 1 param → 204404502
GET
/webhook-templates/{id}
Get webhook template details
getWebhookTemplate 1 param → 200400404500502
DELETE
/templates/{id}
Delete template
deleteTemplate 1 param → 204404502
GET
/templates/{id}
Get template details
getTemplate 1 param → 200400404500502
PATCH
/config
Update config
updateConfigKey body → 200400404500
GET
/config
Get config
getConfig → 200404500
GET
/debug
Get debug information
getDebugInfo → 200500502
GET
/export
Export execution data
exportExecutions 1 param → 200400413500
DELETE
/test-sources/{id}
Delete test source
deleteTestSource 1 param → 204502
GET
/test-sources/{id}
Get test source data
getTestSource 1 param → 200400404502500
POST
/uploads
Upload file
uploads body → 200400500
POST
/test-workflow-executions
Execute test workflows
executeTestWorkflows 2 params body → 200400402502

Schemas 198

The contract defines 198 schemas that model the data the API accepts and returns. The most detailed are ExecutionRequest (49 properties), Execution (38 properties), TestWorkflowStepExecuteTestExecutionRequest (28 properties), TestWorkflowExecution (25 properties). Each schema is shown below with its type and property counts.

PodSecurityContext
object
13 properties
TestSuiteStepV2
object
3 properties 3 required
ExecutionsTotals
object
various execution counters
5 properties 6 required
TestWorkflowExecutionResourceAggregationsReport
object
TestWorkflowExecutionResourceAggregationsReport provides resource usage aggregations for an entire TestWorkflowExecution (globally) and also per-step (by measu…
2 properties
TestWorkflowStepStatus
string
Config
object
Testkube API config data structure
3 properties 3 required
PodResourcesRequest
object
pod resources request specification
2 properties
HTTPGetAction
object
5 properties
ExecutionRequest
object
test execution request body
49 properties
HTTPHeader
object
2 properties
ConfigMapVolumeSource
object
configMap represents a configMap that should populate this volume
4 properties
TestWorkflowSignature
object
7 properties
TestWorkflowStepResult
object
6 properties
Sysctl
object
2 properties
TestSuiteStep
object
3 properties
SecurityContext
object
12 properties
TestWorkflowExecutionResourceAggregationsByMeasurement
object
TestWorkflowExecutionResourceAggregationsByMeasurement provides resource usage aggregations for a specific measurement (e.g. CPU, Memory, etc.) across all step…
TestWorkflowRunningContextInterface
object
running context interface for test workflow execution
2 properties 1 required
TestWorkflowExecution
object
25 properties 3 required
VariableType
string
TestWorkflowStepExecuteTestWorkflowRef
object
TestWorkflowContentGit
object
12 properties
TypedObjectReference
object
TypedObjectReference contains enough information to let you locate the typed referenced object inside the specified namespace
1 property
DownloadArtifactOptions
object
options to download artifacts from previous steps
3 properties
TestWorkflowExecutionRequest
object
10 properties
TestSuiteExecution
object
Test suite executions data
17 properties 3 required
TestWorkflowStepControl
object
5 properties
TestSuiteStepType
string
GCEPersistentDiskVolumeSource
object
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/doc…
4 properties 1 required
AzureFileVolumeSource
object
azureFile represents an Azure File Service mount on the host and bind mount to the pod.
3 properties 2 required
WebhookConfigValue
object
configuration value
2 properties
TestSuiteBatchStep
object
set of steps run in parallel
3 properties 1 required
TestWorkflowResult
object
13 properties 5 required
SilentMode
object
controls what aspects of an execution should be silent (not tracked/processed)
5 properties
Toleration
object
5 properties
TestWorkflowExecutionRuntime
object
runtime configuration for a specific test workflow execution
1 property
HostPathVolumeSource
object
hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or…
2 properties 1 required
NFSVolumeSource
object
nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumesnfs
3 properties 2 required
TestWorkflowOutput
object
3 properties
PodRequest
object
pod request body
3 properties
TypedLocalObjectReference
object
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace
3 properties
TestWorkflowStatusSummary
object
test workflow status
1 property
AWSElasticBlockStoreVolumeSource
object
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io…
4 properties 1 required
TestSuiteStepExecutionResultV2
object
execution result returned from executor
3 properties
HostAlias
object
2 properties
ExecutionsResult
object
the result for a page of executions
3 properties 2 required
ExecutionResult
object
execution result returned from executor
6 properties 1 required
TestWorkflowStepArtifacts
object
3 properties 1 required
BoxedBoolean
object
1 property 1 required
ExecutionStepResult
object
execution result data
4 properties 2 required
SlavesMeta
object
Slave data for executing tests in distributed environment
1 property 1 required
Artifact
object
API server artifact
4 properties
TestWorkflowTarballRequest
object
2 properties 1 required
PodDNSConfig
object
3 properties
BoxedString
object
1 property 1 required
TestWorkflowStepArtifactsCompression
object
1 property
TestWorkflowExecutionSchema
object
test workflow execution configuration
3 properties
SELinuxOptions
object
4 properties
TestWorkflowRunningContextActorType
string
supported actors for test workflow running context
TestWorkflowStepRun
object
11 properties
TestWorkflowExecutionConfig
object
map of configuration values used in the test workflow execution
AssertionResult
object
execution result data
3 properties
PodAffinityTerm
object
4 properties
TestSource
object
Test source resource for shared test content
3 properties
AppArmorProfile
object
2 properties
TestWorkflowReportSummary
object
6 properties
TestContent
object
4 properties
WeightedPodAffinityTerm
object
2 properties 1 required
TestWorkflowStepParallelTransfer
object
4 properties 1 required
ExecutionSummary
object
Execution summary
13 properties 5 required
ExecAction
object
1 property
TemplatableBoxedInteger
object
1 property 1 required
Execution
object
test execution
38 properties
SeccompProfile
object
2 properties
Variable
object
5 properties
TestSuiteStepExecutionResult
object
execution result returned from executor
3 properties
WebhookTemplate
object
CRD based webhook data template
16 properties 1 required
Problem
object
problem response in case of error
5 properties
Capabilities
object
2 properties
TestWorkflowConfigSchema
object
configuration definition
NodeSelector
object
1 property
TestWorkflowContent
object
3 properties
WebhookTemplateRef
object
1 property 1 required
TestWorkflowStatus
string
TestSuiteBatchStepExecutionSummary
object
Test suite batch execution summary
1 property
NodeAffinity
object
2 properties
ImagePullPolicy
string
TestWorkflowPause
object
3 properties 2 required
EmptyDirVolumeSource
object
emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumesemptydir
2 properties
TestWorkflowConfigValue
object
configuration values to pass to the template
SecretEnvSource
object
2 properties 1 required
Volume
object
Volume represents a named volume in a pod that may be accessed by any container in the pod.
14 properties 1 required
ContentGitAuthType
string
auth type for git requests
EnvReference
object
Reference to env resource
4 properties 1 required
WebhookConfig
object
configuration values
ClaimSource
object
2 properties
Variables
object
execution variables passed to executor converted to vars for usage in tests
EnvVarSource
object
EnvVarSource represents a source for the value of an EnvVar.
4 properties
EventType
string
TestWorkflowContentTarball
object
3 properties 2 required
LabelSelector
object
2 properties
PodDNSConfigOption
object
2 properties
TestWorkflowIndependentServiceSpec
object
BoxedInteger
object
1 property 1 required
PersistentVolumeClaimVolumeSource
object
persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/stora…
2 properties 1 required
TestSuiteStepExecutionRequest
object
test step execution request body
19 properties
TestWorkflowJobConfig
object
4 properties
TestSuiteStepExecutionSummary
object
Test suite execution summary
5 properties 3 required
TestWorkflowRunningContextActor
object
running context actor for test workflow execution
6 properties 1 required
ProjectedVolumeSource
object
Represents a projected volume source
2 properties
TestWorkflowRunningContext
object
running context for test workflow execution
2 properties 2 required
TestWorkflowSystem
object
2 properties
PreferredSchedulingTerm
object
2 properties 1 required
TemplateType
string
template type by purpose
LabelSelectorRequirement
object
3 properties
TestWorkflowStepOperations
object
5 properties
WebhookParameterSchema
object
parameter definition
6 properties 1 required
TestWorkflowContainerConfig
object
10 properties
ExecutorDetails
object
Executor details with Executor data and additional information like list of executions
3 properties
TopologySpreadConstraint
object
8 properties
CephFSVolumeSource
object
cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
6 properties 1 required
TestWorkflowStepExecute
object
4 properties
GRPCAction
object
2 properties
TestWorkflowTagValue
object
tag values to pass to the test workflow execution
TestWorkflowStepExecuteTestExecutionRequest
object
28 properties
WindowsSecurityContextOptions
object
4 properties
ResourceRequest
object
resource request specification
2 properties
AzureDiskVolumeSource
object
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
6 properties 2 required
ExecutorMeta
object
Executor meta data
3 properties
TestWorkflowRetryPolicy
object
2 properties 1 required
TestWorkflowServiceSpec
object
EnvFromSource
object
3 properties
NodeSelectorTerm
object
2 properties
TestWorkflowReport
object
4 properties
TestWorkflowEvent
object
1 property
Syncable
object
source information about resources that may have been synced from multiple sources. An empty source indicates that the source was the UI/API for backwards comp…
2 properties
Webhook
object
CRD based webhook data
19 properties 1 required
TestSuiteExecutionRequest
object
test suite execution request body
24 properties
TestSuiteExecutionSummary
object
Test execution summary
10 properties 4 required
ConfigMapRef
object
Testkube internal reference for data in Kubernetes config maps
3 properties 2 required
PodAffinity
object
2 properties
TestWorkflowStepParallelFetch
object
3 properties 1 required
ObjectRef
object
2 properties 1 required
TestWorkflowCronJobConfig
object
cron job configuration
6 properties 1 required
Probe
object
Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
10 properties
PodSchedulingGate
object
1 property
TestWorkflowStepParallel
object
ExecutionStatus
string
TestWorkflowPodConfig
object
24 properties
TestWorkflowExecutionConfigValue
object
configuration values used in the test workflow execution
6 properties
BoxedStringList
object
1 property 1 required
PodResourceClaim
object
2 properties
TestSuiteStepExecuteTestV2
Template
object
Golang based template
5 properties 3 required
TestWorkflowStepExecuteStrategy
object
4 properties
CSIVolumeSource
object
Represents a source location of a volume to mount, managed by an external CSI driver
5 properties
TestSuiteBatchStepExecutionResult
object
execution result returned from executor
5 properties
TestSuiteExecutionStatus
string
EnvVar
object
4 properties
TestWorkflowTarballFilePattern
object
dynamic expression or static list of file patterns to pack
2 properties
Affinity
object
3 properties
RepositoryParameters
object
repository parameters for tests in git repositories
4 properties
LocalObjectReference
object
Reference to Kubernetes object
1 property
Executor
object
CRD based executor data
15 properties
TestWorkflowExecutionHealth
object
3 properties 3 required
SecretRef
object
Testkube internal reference for secret storage in Kubernetes secrets
3 properties 2 required
FieldRef
object
Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels[' '], metadata.annotations[' '], spec.nodeName, spec.serviceAccountName…
2 properties 1 required
SecretVolumeSource
object
secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumessecret
4 properties
TestSuiteExecutionsResult
object
the result for a page of executions
3 properties 2 required
TestSuiteStepDelayV2
object
1 property 1 required
DebugInfo
object
Testkube debug info
5 properties
TestWorkflowResourcesList
object
4 properties
ExecutionTarget
object
3 properties
RunningContext
object
running context for test or test suite execution
2 properties 1 required
TestWorkflow
object
11 properties
TestWorkflowParameterType
string
type of the config parameter
TestContentRequest
object
test content request body
1 property
Source
string
synchronisation sources
TestWorkflowExecutionResourceAggregations
object
TestWorkflowExecutionResourceAggregations provides min, max, average, total, and standard deviation values for a resource metric.
5 properties
TestWorkflowResources
object
2 properties
VolumeMount
object
VolumeMount describes a mounting of a Volume within a container.
6 properties 2 required
TestWorkflowTimeouts
object
configures timeout behavior for a workflow (queue, initialization)
2 properties
ConfigMapEnvSource
object
2 properties 1 required
Repository
object
repository representation for tests in git repositories
12 properties 2 required
TestWorkflowRunningContextInterfaceType
string
supported interfaces for test workflow running context
TestWorkflowSpec
object
16 properties
TestWorkflowParameterSchema
object
15 properties 1 required
TestWorkflowTemplateRef
object
2 properties 1 required
TestWorkflowPvcConfig
object
9 properties
TCPSocketAction
object
2 properties
NodeSelectorRequirement
object
3 properties
TestWorkflowStepExecuteTestRef
object
ResourceFieldRef
object
Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and…
3 properties 1 required
ArtifactRequest
object
artifact request body with test artifacts
9 properties
TestWorkflowConcurrencyPolicy
object
configuration to control concurrent executions.
3 properties
TestWorkflowContentFile
object
4 properties 1 required
TestWorkflowStep
object
23 properties
TestWorkflowExecutionStepResourceAggregations
object
Step-based resource metrics aggregations (by measurement and field)
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubeshop-api-api-openapi.yml Raw ↑

Other APIs Kubeshop publishes across the network.

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 repository API
Kubeshop secrets API
Kubeshop Status Pages API
Kubeshop tags API
Where this information came from

This is an independent, third-party profile of Kubeshop api API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.