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

Kubeshop api API

Testkube API operations

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

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

This API exposes 129 operations across 72 paths, and defines 264 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://.

129 operations 72 paths 264 schemas 21 DELETE62 GET15 PATCH27 POST4 PUT

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
License
Resource Areas
1

Paths & Operations 129

Across 72 paths, the API surfaces 129 operations — 21 DELETE, 62 GET, 15 PATCH, 27 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

api 129

Testkube API operations

GET
/cluster-resources
List cluster resources
listClusterResources 1 param → 200501502
GET
/keymap/triggers
Test triggers keymap
getKeyMap → 200
GET
/triggers
List test triggers
listTestTriggers 2 params → 200400502
POST
/triggers
Create new test trigger
createTestTrigger body → 200400502
PATCH
/triggers
Bulk update test triggers
bulkUpdateTestTriggers body → 200400502
DELETE
/triggers
Delete test triggers
deleteTestTriggers 2 params → 204400404502
GET
/triggers/{id}
Get test trigger by ID
getTestTriggerByID 2 params → 200404502
PATCH
/triggers/{id}
Update test trigger
updateTestTrigger 3 params body → 200400404502
DELETE
/triggers/{id}
Delete test trigger
deleteTestTrigger 2 params → 204404502
POST
/test-suites
Create new test suite
createTestSuite body → 200201400502
GET
/test-suites
Get all test suites
listTestSuites 2 params → 200400502
DELETE
/test-suites
Delete test suites
deleteTestSuites 1 param → 204404502
GET
/test-suites/{id}
Get test suite by ID
getTestSuiteByID 1 param → 200404500502
PATCH
/test-suites/{id}
Update test suite
updateTestSuite 1 param body → 200400404502
DELETE
/test-suites/{id}
Delete test suite
deleteTestSuite 2 params → 204404502
GET
/test-suites/{id}/metrics
Get test suite metrics
getTestSuiteMetrics 3 params → 200500
GET
/test-suites/{id}/tests
List tests for test suite
listTestSuiteTests 1 param → 200404502
POST
/test-suites/{id}/abort
Abort all executions of a test suite
abortTestSuiteExecutions 1 param → 204404500502
GET
/test-suite-with-executions
Get all test suite with executions
listTestSuiteWithExecutions 5 params → 200400500502
GET
/test-suite-with-executions/{id}
Get test suite by ID with execution
getTestSuiteByIDWithExecution 1 param → 200500
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
/executions
Starts new test executions
executeTests 4 params body → 201400404502500
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
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
GET
/executors
List executors
listExecutors 1 param → 200400502
POST
/executors
Create new executor
createExecutor body → 200201400502
DELETE
/executors
Delete executors
deleteExecutors 1 param → 204502
DELETE
/executors/{id}
Delete executor
deleteExecutor 1 param → 204502
GET
/executors/{id}
Get executor details
getExecutor 1 param → 200400502500
PATCH
/executors/{id}
Update executor
updateExecutor 1 param body → 200400404502
GET
/executor-by-types
Get executor details by type
getExecutorByType 1 param → 200400502500
GET
/webhooks
List webhooks
listWebhooks 1 param → 200400502
POST
/webhooks
Create new webhook
createWebhook body → 200201400502
DELETE
/webhooks
Delete webhooks
deleteWebhooks 1 param → 204502
DELETE
/webhooks/{id}
Delete webhook
deleteWebhook 1 param → 204404502
GET
/webhooks/{id}
Get webhook details
getWebhook 1 param → 200400404500502
PATCH
/webhooks/{id}
Update new webhook
updateWebhook 1 param body → 200400404502
GET
/webhook-templates
List webhook templates
listWebhookTemplates 1 param → 200400502
POST
/webhook-templates
Create new webhook template
createWebhookTemplate body → 200201400502
DELETE
/webhook-templates
Delete webhook templates
deleteWebhookTemplates 1 param → 204502
DELETE
/webhook-templates/{id}
Delete webhook template
deleteWebhookTemplate 1 param → 204404502
GET
/webhook-templates/{id}
Get webhook template details
getWebhookTemplate 1 param → 200400404500502
PATCH
/webhook-templates/{id}
Update new webhook template
updateWebhookTemplate 1 param body → 200400404502
GET
/templates
List templates
listTemplates 1 param → 200400502
POST
/templates
Create new template
createTemplate body → 200201400502
DELETE
/templates
Delete templates
deleteTemplates 1 param → 204502
DELETE
/templates/{id}
Delete template
deleteTemplate 1 param → 204404502
GET
/templates/{id}
Get template details
getTemplate 1 param → 200400404500502
PATCH
/templates/{id}
Update new template
updateTemplate 1 param body → 200400404502
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
GET
/test-sources
List test sources
listTestSources 1 param → 200400502
POST
/test-sources
Create new test source
createTestSource body → 200201400502
PATCH
/test-sources
Process test source batch (create, update, delete)
processTestSourceBatch body → 200400502
DELETE
/test-sources
Delete test sources
deleteTestSources 1 param → 204502
PATCH
/test-sources/{id}
Update test source
updateTestSource 1 param body → 200400404502
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
/repositories
Validate new repository
validateRepository body → 204400500502
GET
/secrets
List secrets
listSecrets 2 params → 200403502
POST
/secrets
Create secret
createSecret body → 200400403502
DELETE
/secrets/{id}
Delete secret
deleteSecret 2 params → 204400403404502
PATCH
/secrets/{id}
Update secret
updateSecret 1 param body → 200400403404502
GET
/secrets/{id}
Get secret
getSecret 1 param → 200400403404502
GET
/test-workflows
List test workflows
listTestWorkflows 1 param → 200400402502
DELETE
/test-workflows
Delete test workflows
deleteTestWorkflows 2 params → 204400402502
POST
/test-workflows
Create test workflow
createTestWorkflow body → 200400402502
PUT
/test-workflows
Validate test workflow
validateTestWorkflow body → 204400502
GET
/test-workflow-with-executions
List test workflows with latest execution
listTestWorkflowWithExecutions 1 param → 200400402502
GET
/test-workflow-with-executions/{id}
Get test workflow details with latest execution
getTestWorkflowWithExecution 1 param → 200402404502
GET
/test-workflow-with-executions/{id}/tags
List test workflow execution tags
listTestWorkflowWithExecutionTags 1 param → 200502
GET
/test-workflows/{id}/executions
List test workflow executions
listTestWorkflowExecutionsByTestWorkflow 4 params → 200400402502
POST
/test-workflows/{id}/executions
Execute test workflow
executeTestWorkflow 2 params body → 200400402502
GET
/test-workflows/{id}/tags
List test workflow execution tags
listTestWorkflowTagsByTestWorkflow 1 param → 200502
GET
/test-workflows/{id}/metrics
Get test workflow metrics
getTestWorkflowMetrics 1 param → 200400402502
GET
/test-workflows/{id}/executions/{executionID}
Get test workflow execution
getTestWorkflowExecutionByTestWorkflow 2 params → 200400402502
POST
/test-workflows/{id}/executions/{executionID}/abort
Abort test workflow execution
abortTestWorkflowExecutionByTestWorkflow 3 params → 204400402502
POST
/test-workflows/{id}/executions/{executionID}/rerun
Rerun test workflow execution
rerunTestWorkflowExecutionByTestWorkflow 2 params body → 200400502
POST
/test-workflow-executions
Execute test workflows
executeTestWorkflows 2 params body → 200400402502
GET
/test-workflow-executions
List test workflow executions
listTestWorkflowExecutions 4 params → 200400402502
GET
/test-workflow-executions/{executionID}
Get test workflow execution
getTestWorkflowExecution 1 param → 200400402502
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
POST
/test-workflow-executions/{executionID}/abort
Abort test workflow execution
abortTestWorkflowExecution 2 params → 204400402502
POST
/test-workflow-executions/{executionID}/rerun
Rerun test workflow execution
rerunTestWorkflowExecution 1 param body → 200400502
POST
/test-workflows/{id}/abort
Abort all test workflow executions
abortAllTestWorkflowExecutions 1 param → 204400402502
POST
/preview-test-workflow
Preview test workflow
previewTestWorkflow 1 param body → 200400402502
GET
/test-workflows/{id}
Get test workflow details
getTestWorkflow 1 param → 200402404502
PUT
/test-workflows/{id}
Update test workflow details
updateTestWorkflow 1 param body → 200402404502
DELETE
/test-workflows/{id}
Delete test workflow
deleteTestWorkflow 3 params → 204402404502
GET
/test-workflow-templates
List test workflow templates
listTestWorkflowTemplates 1 param → 200400402502
DELETE
/test-workflow-templates
Delete test workflow templates
deleteTestWorkflowTemplates 1 param → 204400402502
POST
/test-workflow-templates
Create test workflow template
createTestWorkflowTemplate body → 200400402502
PUT
/test-workflow-templates
Validate test workflow template
validateTestWorkflowTemplate body → 204400502
GET
/test-workflow-templates/{id}
Get test workflow template details
getTestWorkflowTemplate 1 param → 200402404502
PUT
/test-workflow-templates/{id}
Update test workflow template details
updateTestWorkflowTemplate 1 param body → 200402404502
DELETE
/test-workflow-templates/{id}
Delete test workflow template
deleteTestWorkflowTemplate 1 param → 204402404502

Schemas 264

The contract defines 264 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.

WebhookTemplateUpdateRequest
object
webhook template update request body
PodDNSConfig
object
3 properties
TestTriggerConcurrencyPolicies
string
supported concurrency policies for test triggers
TestSuiteStepExecutionSummary
object
Test suite execution summary
5 properties 3 required
TestTriggerUpsertRequest
object
test trigger create or update request body
4 required
PodResourceClaim
object
2 properties
TestSuiteWithExecution
object
Test suite with latest execution result
2 properties 1 required
ImagePullPolicy
string
TestWorkflowSummary
object
5 properties
TestStatus
object
test status
1 property
TestUpsertRequest
object
test create request body
PodRequest
object
pod request body
3 properties
ExecutionsMetrics
object
12 properties
TestWorkflowStatus
string
WebhookTemplateCreateRequest
object
webhook template create request body
NodeSelector
object
1 property
ResourceRequest
object
resource request specification
2 properties
WebhookTemplate
object
CRD based webhook data template
16 properties 1 required
TestTriggerProbeSpec
object
3 properties
LogV1
object
Log format version 1
1 property 1 required
ExecAction
object
1 property
TestWorkflowCronJobConfig
object
cron job configuration
6 properties 1 required
TestWorkflowPause
object
3 properties 2 required
ProjectedVolumeSource
object
Represents a projected volume source
2 properties
TestWorkflowStepParallelTransfer
object
4 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
TestTriggerFieldCondition
object
3 properties 2 required
PodResourcesRequest
object
pod resources request specification
2 properties
WebhookCreateRequest
object
webhook create request body
TestWorkflowSpec
object
16 properties
ExecutionTarget
object
3 properties
TestSuiteUpdateRequest
object
test suite update body
TestWorkflowEvent
object
1 property
AzureDiskVolumeSource
object
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
6 properties 2 required
WebhookTemplateRef
object
1 property 1 required
TestSuite
object
13 properties 2 required
TestSuiteExecution
object
Test suite executions data
17 properties 3 required
ExecutionRequest
object
test execution request body
49 properties
TestWorkflowExecutionsResult
object
3 properties 3 required
GRPCAction
object
2 properties
PodAffinity
object
2 properties
TestContent
object
4 properties
TestSuiteStepType
string
TestWithExecutionSummary
object
Test with latest Execution result summary
2 properties 1 required
ExecutorDetails
object
Executor details with Executor data and additional information like list of executions
3 properties
TestSuiteStepDelayV2
object
1 property 1 required
TestWorkflowServiceSpec
object
SecurityContext
object
12 properties
TestWorkflowConfigSchema
object
configuration definition
TestWorkflowExecutionHealth
object
3 properties 3 required
TestWorkflowReport
object
4 properties
TestTriggerConditionStatuses
string
supported kubernetes condition statuses for test triggers
Problem
object
problem response in case of error
5 properties
NodeSelectorTerm
object
2 properties
TestWorkflowExecutionConfigValue
object
configuration values used in the test workflow execution
6 properties
Execution
object
test execution
38 properties
PodDNSConfigOption
object
2 properties
TestSuiteExecutionCore
object
test suite execution core
4 properties
TestWorkflowExecutionSummary
object
16 properties 3 required
ExecutorUpdateRequest
object
executor update request body
TestSuiteStepExecutionResult
object
execution result returned from executor
3 properties
EnvReference
object
Reference to env resource
4 properties 1 required
SecretUpdate
object
Secret input information to update
4 properties
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
TestTriggerContentGit
object
15 properties 1 required
EnvVarSource
object
EnvVarSource represents a source for the value of an EnvVar.
4 properties
TestWorkflowTemplateRef
object
2 properties 1 required
TestSuiteStep
object
3 properties
VariableType
string
LabelSelector
object
2 properties
TestWorkflowIndependentStepParallel
object
SilentMode
object
controls what aspects of an execution should be silent (not tracked/processed)
5 properties
TestWithExecution
object
Test with latest Execution result
2 properties 1 required
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
PodSchedulingGate
object
1 property
PreferredSchedulingTerm
object
2 properties 1 required
WebhookConfigValue
object
configuration value
2 properties
CSIVolumeSource
object
Represents a source location of a volume to mount, managed by an external CSI driver
5 properties
Secret
object
Secret with keys
9 properties 2 required
TestWorkflowResourcesList
object
4 properties
TopologySpreadConstraint
object
8 properties
WindowsSecurityContextOptions
object
4 properties
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
ExecutionCore
object
test execution core
5 properties
TestTriggerFieldOperator
string
supported comparison operators for TestTrigger match conditions
TestWorkflowWithExecution
object
2 properties
DownloadArtifactOptions
object
options to download artifacts from previous steps
3 properties
TestWorkflowStepParallel
object
HTTPHeader
object
2 properties
Test
object
13 properties
TestWorkflowStepExecuteTestRef
object
TestSuiteStepExecutionRequest
object
test step execution request body
19 properties
VolumeMount
object
VolumeMount describes a mounting of a Volume within a container.
6 properties 2 required
HostAlias
object
2 properties
TestSourceUpdateRequest
object
test source update request body
3 properties
TestContentRequest
object
test content request body
1 property
TestTriggerContentSelector
object
1 property
Variable
object
5 properties
TestWorkflowRunningContextActor
object
running context actor for test workflow execution
6 properties 1 required
TestWorkflow
object
11 properties
TestSourceBatchRequest
object
Test source batch request
1 property 1 required
TestWorkflowIndependentServiceSpec
object
Executor
object
CRD based executor data
15 properties
TestWorkflowTarballRequest
object
2 properties 1 required
Repository
object
repository representation for tests in git repositories
12 properties 2 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
TestWorkflowExecutionConfig
object
map of configuration values used in the test workflow execution
ExecutionSummary
object
Execution summary
13 properties 5 required
TestWorkflowContent
object
3 properties
WebhookParameterSchema
object
parameter definition
6 properties 1 required
WebhookUpdateRequest
object
webhook update request body
TestWorkflowParameterSchema
object
15 properties 1 required
TestWorkflowRunningContextActorType
string
supported actors for test workflow running context
PodSecurityContext
object
13 properties
TestSuiteStepV2
object
3 properties 3 required
TestSuiteExecutionStatus
string
AppArmorProfile
object
2 properties
ExecutionResult
object
execution result returned from executor
6 properties 1 required
AssertionResult
object
execution result data
3 properties
TestWorkflowStep
object
23 properties
SELinuxOptions
object
4 properties
TestSuiteBatchStep
object
set of steps run in parallel
3 properties 1 required
TCPSocketAction
object
2 properties
TemplateCreateRequest
object
template create request body
ExecutionStepResult
object
execution result data
4 properties 2 required
SecretRef
object
Testkube internal reference for secret storage in Kubernetes secrets
3 properties 2 required
TestWorkflowPvcConfig
object
9 properties
WeightedPodAffinityTerm
object
2 properties 1 required
TestWorkflowStepParallelFetch
object
3 properties 1 required
TestTriggerCondition
object
supported condition for test triggers
4 properties 2 required
EventType
string
Webhook
object
CRD based webhook data
19 properties 1 required
TestWorkflowIndependentStep
object
21 properties
TestWorkflowStatusSummary
object
test workflow status
1 property
TestSuiteExecutionsResult
object
the result for a page of executions
3 properties 2 required
TestWorkflowSystem
object
2 properties
TestWorkflowRunningContextInterfaceType
string
supported interfaces for test workflow running context
HTTPGetAction
object
5 properties
TestSource
object
Test source resource for shared test content
3 properties
TestWorkflowResultSummary
object
10 properties 5 required
TestWorkflowConcurrencyPolicy
object
configuration to control concurrent executions.
3 properties
TestWorkflowExecutionSchema
object
test workflow execution configuration
3 properties
SlavesMeta
object
Slave data for executing tests in distributed environment
1 property 1 required
RunningContext
object
running context for test or test suite execution
2 properties 1 required
TemplatableBoxedInteger
object
1 property 1 required
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
NodeAffinity
object
2 properties
TestUpdateRequest
object
test update request body
TestWorkflowStepRun
object
11 properties
LabelSelectorRequirement
object
3 properties
TestTriggerResources
string
supported kubernetes resources for test triggers
TestTriggerContentGitPullRequest
object
Pull request trigger configuration for GitHub API polling.
3 properties
ArtifactRequest
object
artifact request body with test artifacts
9 properties
TestWorkflowExecutionResourceAggregations
object
TestWorkflowExecutionResourceAggregations provides min, max, average, total, and standard deviation values for a resource metric.
5 properties
ExecutionsTotals
object
various execution counters
5 properties 6 required
ConfigMapVolumeSource
object
configMap represents a configMap that should populate this volume
4 properties
SecretInput
object
Secret input information
6 properties 2 required
ConfigMapRef
object
Testkube internal reference for data in Kubernetes config maps
3 properties 2 required
ConfigMapEnvSource
object
2 properties 1 required
TestSuiteStepExecutionResultV2
object
execution result returned from executor
3 properties
TestSuiteStepExecuteTestV2
EnvFromSource
object
3 properties
TestSourceBatchResult
object
Test source batch result
3 properties
NodeSelectorRequirement
object
3 properties
TestWorkflowReportSummary
object
6 properties
ExecutionStatus
string
TestWorkflowTemplate
object
9 properties
TestSourceUpsertRequest
object
test source create request body
3 properties
TestWorkflowExecutionRuntime
object
runtime configuration for a specific test workflow execution
1 property
LocalObjectReference
object
Reference to Kubernetes object
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
TestWorkflowTagValue
object
tag values to pass to the test workflow execution
RepositoryParameters
object
repository parameters for tests in git repositories
4 properties
TestWorkflowRunningContext
object
running context for test workflow execution
2 properties 2 required
SecretOwner
object
Resource that owns the secret
2 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
TestWorkflowRunningContextInterface
object
running context interface for test workflow execution
2 properties 1 required
TestWorkflowStepArtifactsCompression
object
1 property
TestTriggerActions
string
supported actions for test triggers
SeccompProfile
object
2 properties
DebugInfo
object
Testkube debug info
5 properties
TestTriggerResourceRef
object
3 properties 1 required
TestWorkflowStepStatus
string
TestSuiteWithExecutionSummary
object
Test suite with latest execution result
2 properties 1 required
TestTriggerKeyMap
object
6 properties 5 required
Config
object
Testkube API config data structure
3 properties 3 required
ExecutorMeta
object
Executor meta data
3 properties
TestWorkflowExecutionResourceAggregationsByMeasurement
object
TestWorkflowExecutionResourceAggregationsByMeasurement provides resource usage aggregations for a specific measurement (e.g. CPU, Memory, etc.) across all step…
TestWorkflowJobConfig
object
4 properties
BoxedInteger
object
1 property 1 required
TestTriggerActionParameters
object
supported action parameters for test triggers
3 properties
ExecutorUpsertRequest
object
executor create request body
3 required
TestWorkflowParameterType
string
type of the config parameter
TestWorkflowTemplateSpec
object
15 properties
WebhookConfig
object
configuration values
BoxedString
object
1 property 1 required
TestWorkflowWithExecutionSummary
object
2 properties
Capabilities
object
2 properties
ClusterResource
object
One GVK the cluster exposes, with the agent's watch permission.
6 properties 5 required
TestWorkflowExecutionResourceAggregationsReport
object
TestWorkflowExecutionResourceAggregationsReport provides resource usage aggregations for an entire TestWorkflowExecution (globally) and also per-step (by measu…
2 properties
Artifact
object
API server artifact
4 properties
TestSuiteUpsertRequest
object
test suite create request body
2 required
TestWorkflowResources
object
2 properties
TestWorkflowStepOperations
object
5 properties
TestWorkflowContentFile
object
4 properties 1 required
TestWorkflowContentGit
object
12 properties
Affinity
object
3 properties
TestTriggerProbe
object
supported probe for test triggers
5 properties
TestWorkflowExecutionRequest
object
10 properties
TestSuiteExecutionSummary
object
Test execution summary
10 properties 4 required
Variables
object
execution variables passed to executor converted to vars for usage in tests
Toleration
object
5 properties
EnvVar
object
4 properties
ExecutionsMetricsExecutions
object
8 properties
BoxedBoolean
object
1 property 1 required
TestTriggerSelector
object
5 properties
Template
object
Golang based template
5 properties 3 required
TestWorkflowStepControl
object
5 properties
TestSuiteExecutionRequest
object
test suite execution request body
24 properties
TypedObjectReference
object
TypedObjectReference contains enough information to let you locate the typed referenced object inside the specified namespace
1 property
TestSuiteBatchStepExecutionResult
object
execution result returned from executor
5 properties
PodAffinityTerm
object
4 properties
ClaimSource
object
2 properties
TestWorkflowStepExecute
object
4 properties
TestWorkflowStepArtifacts
object
3 properties 1 required
TestSuiteStatus
object
test suite status
1 property
TestWorkflowContentTarball
object
3 properties 2 required
TestWorkflowTarballFilePattern
object
dynamic expression or static list of file patterns to pack
2 properties
TestTriggerConditionSpec
object
3 properties
LogV2
object
Log format version 2
8 properties 2 required
ExecutorOutput
object
CRD based executor data
4 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
TestWorkflowStepExecuteTestWorkflowRef
object
TemplateUpdateRequest
object
template update request body
TestWorkflowStepExecuteTestExecutionRequest
object
28 properties
TestWorkflowExecutionStepResourceAggregations
object
Step-based resource metrics aggregations (by measurement and field)
2 properties
TestSuiteBatchStepExecutionSummary
object
Test suite batch execution summary
1 property
ContentGitAuthType
string
auth type for git requests
ExecutionsResult
object
the result for a page of executions
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
TestWorkflowConfigValue
object
configuration values to pass to the template
CephFSVolumeSource
object
cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
6 properties 1 required
TestWorkflowContainerConfig
object
10 properties
TestWorkflowStepExecuteStrategy
object
4 properties
Source
string
synchronisation sources
TestTrigger
object
21 properties 4 required
TemplateType
string
template type by purpose
TestWorkflowSignature
object
7 properties
AzureFileVolumeSource
object
azureFile represents an Azure File Service mount on the host and bind mount to the pod.
3 properties 2 required
TestWorkflowOutput
object
3 properties
TestWorkflowResult
object
13 properties 5 required
TypedLocalObjectReference
object
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace
3 properties
TestWorkflowRetryPolicy
object
2 properties 1 required
TestWorkflowStepResult
object
6 properties
ObjectRef
object
2 properties 1 required
BoxedStringList
object
1 property 1 required
TestWorkflowExecution
object
25 properties 3 required
Sysctl
object
2 properties
SecretEnvSource
object
2 properties 1 required
TestWorkflowTimeouts
object
configures timeout behavior for a workflow (queue, initialization)
2 properties
Volume
object
Volume represents a named volume in a pod that may be accessed by any container in the pod.
14 properties 1 required
TestTriggerExecutions
string
supported test resources for test triggers
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
TestWorkflowPodConfig
object
24 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 pro API
Kubeshop repository API
Kubeshop secrets API
Kubeshop Status Pages API