Testkube Control Plane ../executions operations
Testkube Pro API (cloud-api/1.10.51)
Download OpenAPI specification:Download
API for Testkube Pro
Generate OpenAI analysis websockets stream
OpenAI analysis websockets stream
Authorizations:
path Parameters
id required | string unique id of the object |
environmentID required | string unique id of the environment |
executionID required | string unique id of the test execution |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "title": "Invalid test name",
- "status": 500,
- "detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
}
Get all test executions
Returns array of test executions
path Parameters
id required | string organizationId |
environmentId required | string environmentID |
testName required | string unique id of the test |
query Parameters
type | string Default: "" object type |
textSearch | string Default: "" text to search in name and test name |
pageSize | integer The desired page size for this list, or a default page size when absent. |
page | integer Default: 0 the page index to start at |
status | string (ExecutionStatus) Enum: "queued" "running" "passed" "failed" "aborted" "timeout" "skipped" optional status filter containing multiple values separated by comma |
startDate | string <date> startDate for filtering in ISO-8601 format, i.e. "yyyy-mm-dd" |
endDate | string <date> endDate for filtering |
selector | string Example: selector=kubernetes.io/app=demo Only workflow executions with given status are included in this time series chart. |
Responses
Response samples
- 200
- 404
- 500
{- "totals": {
- "results": 0,
- "passed": 0,
- "failed": 0,
- "queued": 0,
- "running": 0
}, - "filtered": {
- "results": 0,
- "passed": 0,
- "failed": 0,
- "queued": 0,
- "running": 0
}, - "results": [
- {
- "id": "62f395e004109209b50edfc4",
- "name": "test-suite1-test1",
- "number": 1,
- "testName": "test1",
- "testNamespace": "testkube",
- "testType": "postman/collection",
- "status": "queued",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "duration": "00:00:13",
- "durationMs": 10000,
- "labels": {
- "app": "backend",
- "env": "prod"
}, - "runningContext": {
- "type": "userCLI",
- "context": "string"
}
}
]
}
Starts new test executions
New test executions returns new executions details on successful executions start
path Parameters
id required | string organizationId |
environmentId required | string environmentID |
query Parameters
namespace | string Default: "testkube" Namespace of the object |
selector | string Example: selector=kubernetes.io/app=demo Only workflow executions with given status are included in this time series chart. |
executionSelector | string Execution Labels to add to executions |
concurrency | integer Default: 10 |
Request Body schema: application/jsonrequired
body passed to configure executions
id | string <bson objectId> execution id |
name | string test execution custom name |
testSuiteName | string unique test suite name (CRD Test suite name), if it's run as a part of test suite |
number | integer test execution number |
object test execution labels | |
namespace | string test kubernetes namespace ("testkube" when not set) |
isVariablesFileUploaded | boolean in case the variables file is too big, it will be uploaded |
variablesFile | string variables file content - need to be in format for particular executor (e.g. postman envs file) |
object (Variables) execution variables passed to executor converted to vars for usage in tests | |
testSecretUUID | string test secret uuid |
testSuiteSecretUUID | string test suite secret uuid, if it's run as a part of test suite |
command | Array of strings executor image command |
args | Array of strings additional executor binary arguments |
args_mode | string Enum: "append" "override" "replace" usage mode for arguments |
image | string container image, executor will run inside this image |
Array of objects (LocalObjectReference) container image pull secrets | |
object Deprecated Environment variables passed to executor. Deprecated: use Basic Variables instead | |
object Deprecated Execution variables passed to executor from secrets. Deprecated: use Secret Variables instead | |
sync | boolean whether to start execution sync or async |
httpProxy | string http proxy for executor containers |
httpsProxy | string https proxy for executor containers |
negativeTest | boolean whether to run test as negative test |
isNegativeTestChangedOnRun | boolean whether negativeTest was changed by user |
activeDeadlineSeconds | integer <int64> duration in seconds the test may be active, until its stopped |
uploads | Array of strings list of file paths that need to be copied into the test from uploads |
bucketName | string minio bucket name to get uploads from |
object (ArtifactRequest) artifact request body with test artifacts | |
jobTemplate | string job template extensions |
jobTemplateReference | string name of the template resource |
cronJobTemplate | string cron job template extensions |
cronJobTemplateReference | string name of the template resource |
object (TestContentRequest) test content request body | |
preRunScript | string script to run before test execution |
postRunScript | string script to run after test execution |
executePostRunScriptBeforeScraping | boolean execute post run script before scraping (prebuilt executor only) |
sourceScripts | boolean run scripts using source command (container executor only) |
scraperTemplate | string scraper template extensions |
scraperTemplateReference | string name of the template resource |
pvcTemplate | string pvc template extensions |
pvcTemplateReference | string name of the template resource |
Array of objects (EnvReference) config map references | |
Array of objects (EnvReference) secret references | |
object (RunningContext) running context for test or test suite execution | |
testExecutionName | string test execution name started the test execution |
downloadArtifactExecutionIDs | Array of strings execution ids for artifacts to download |
downloadArtifactTestNames | Array of strings test names for artifacts to download from latest executions |
object (PodRequest) pod request body | |
executionNamespace | string namespace for test execution (Pro edition only) |
disableWebhooks | boolean Default: false whether webhooks on this execution are disabled |
Responses
Request samples
- Payload
{- "id": "62f395e004109209b50edfc1",
- "name": "testing with 1000 users",
- "testSuiteName": "test-suite1",
- "number": 0,
- "executionLabels": {
- "prefix": "some-",
- "users": "3"
}, - "namespace": "testkube",
- "isVariablesFileUploaded": false,
- "variablesFile": "string",
- "variables": {
- "secret1": {
- "name": "secret1",
- "type": "secret",
- "value": "secretvalue1"
}, - "var1": {
- "name": "var1",
- "type": "basic",
- "value": "value1"
}
}, - "testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
- "testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
- "command": [
- "curl"
], - "args": [
- "--repeats",
- "5",
- "--insecure"
], - "args_mode": "append",
- "image": "kubeshop/testkube-executor-custom:1.10.11-dev-0a9c91",
- "imagePullSecrets": [
- {
- "name": "string"
}
], - "envs": {
- "prefix": "some-",
- "record": "true"
}, - "secretEnvs": {
- "secret_Key_name2": "secret-name",
- "secret_key_name1": "secret-name"
}, - "sync": true,
- "httpProxy": "user:pass@my.proxy.server:8080",
- "httpsProxy": "user:pass@my.proxy.server:8081",
- "negativeTest": false,
- "isNegativeTestChangedOnRun": false,
- "activeDeadlineSeconds": 1,
- "uploads": [
- "settings/config.txt"
], - "bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
- "artifactRequest": {
- "storageClassName": "artifact-volume-local",
- "volumeMountPath": "string",
- "dirs": [
- "string"
], - "masks": [
- "string"
], - "storageBucket": "test1-artifacts",
- "omitFolderPerExecution": true,
- "sharedBetweenPods": true,
- "useDefaultStorageClassName": true,
- "sidecarScraper": true
}, - "jobTemplate": "string",
- "jobTemplateReference": "string",
- "cronJobTemplate": "string",
- "cronJobTemplateReference": "string",
- "contentRequest": {
- "repository": {
- "branch": "main",
- "commit": "b928cbb7186944ab9275937ec1ac3d3738ca2e1d",
- "path": "test/perf",
- "workingDir": "/"
}
}, - "preRunScript": "echo -n '$SECRET_ENV' > ./secret_file",
- "postRunScript": "sleep 30",
- "executePostRunScriptBeforeScraping": true,
- "sourceScripts": true,
- "scraperTemplate": "string",
- "scraperTemplateReference": "string",
- "pvcTemplate": "string",
- "pvcTemplateReference": "string",
- "envConfigMaps": [
- {
- "reference": {
- "name": "string"
}, - "mount": "/etc/data",
- "mountPath": "string",
- "mapToVariables": false
}
], - "envSecrets": [
- {
- "reference": {
- "name": "string"
}, - "mount": "/etc/data",
- "mountPath": "string",
- "mapToVariables": false
}
], - "runningContext": {
- "type": "userCLI",
- "context": "string"
}, - "testExecutionName": "string",
- "downloadArtifactExecutionIDs": [
- "string"
], - "downloadArtifactTestNames": [
- "string"
], - "slavePodRequest": {
- "resources": {
- "requests": {
- "cpu": "250m",
- "memory": "64Mi"
}, - "limits": {
- "cpu": "250m",
- "memory": "64Mi"
}
}, - "podTemplate": "string",
- "podTemplateReference": "string"
}, - "executionNamespace": "string",
- "disableWebhooks": [
- true,
- false
]
}
Response samples
- 201
- 400
- 404
- 500
- 502
[- {
- "status": "queued",
- "output": "string",
- "outputType": "text/plain",
- "errorMessage": "string",
- "steps": [
- {
- "name": "step1",
- "duration": "10m0s",
- "status": "passed",
- "assertionResults": [
- {
- "name": "assertion1",
- "status": "passed",
- "errorMessage": "string"
}
]
}
], - "reports": {
- "junit": "string"
}
}
]
Get test execution by ID
Returns execution with given executionID
path Parameters
id required | string organizationId |
environmentId required | string environmentID |
executionID required | string unique id of the object execution |
Responses
Response samples
- 200
- 404
- 500
- 502
{- "id": "62f395e004109209b50edfc4",
- "testName": "example-test",
- "testSuiteName": "test-suite1",
- "testNamespace": "testkube",
- "testType": "postman/collection",
- "name": "test-suite1-example-test-1",
- "number": 1,
- "envs": {
- "prefix": "some-",
- "record": "true"
}, - "command": [
- "curl"
], - "args": [
- "--concurrency",
- "2",
- "--remote",
- "--some",
- "blabla"
], - "args_mode": "append",
- "variables": {
- "secret1": {
- "name": "secret1",
- "type": "secret",
- "value": "secretvalue1"
}, - "var1": {
- "name": "var1",
- "type": "basic",
- "value": "value1"
}
}, - "isVariablesFileUploaded": false,
- "variablesFile": "string",
- "testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
- "testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
- "content": {
- "type": "string",
- "repository": {
- "type": "git",
- "branch": "main",
- "commit": "b928cbb7186944ab9275937ec1ac3d3738ca2e1d",
- "path": "test/perf",
- "username": "string",
- "token": "string",
- "usernameSecret": {
- "namespace": "string",
- "name": "string",
- "key": "string"
}, - "tokenSecret": {
- "namespace": "string",
- "name": "string",
- "key": "string"
}, - "certificateSecret": "string",
- "workingDir": "/",
- "authType": "basic"
}, - "data": "string",
}, - "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z",
- "duration": "88s",
- "durationMs": 10000,
- "executionResult": {
- "status": "queued",
- "output": "string",
- "outputType": "text/plain",
- "errorMessage": "string",
- "steps": [
- {
- "name": "step1",
- "duration": "10m0s",
- "status": "passed",
- "assertionResults": [
- {
- "name": "assertion1",
- "status": "passed",
- "errorMessage": "string"
}
]
}
], - "reports": {
- "junit": "string"
}
}, - "labels": {
- "app": "backend",
- "env": "prod"
}, - "uploads": [
- "settings/config.txt"
], - "bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
- "artifactRequest": {
- "storageClassName": "artifact-volume-local",
- "volumeMountPath": "string",
- "dirs": [
- "string"
], - "masks": [
- "string"
], - "storageBucket": "test1-artifacts",
- "omitFolderPerExecution": true,
- "sharedBetweenPods": true,
- "useDefaultStorageClassName": true,
- "sidecarScraper": true
}, - "preRunScript": "echo -n '$SECRET_ENV' > ./secret_file",
- "postRunScript": "sleep 30",
- "executePostRunScriptBeforeScraping": true,
- "sourceScripts": true,
- "runningContext": {
- "type": "userCLI",
- "context": "string"
}, - "containerShell": "/bin/sh",
- "testExecutionName": "string",
- "downloadArtifactExecutionIDs": [
- "string"
], - "downloadArtifactTestNames": [
- "string"
], - "slavePodRequest": {
- "resources": {
- "requests": {
- "cpu": "250m",
- "memory": "64Mi"
}, - "limits": {
- "cpu": "250m",
- "memory": "64Mi"
}
}, - "podTemplate": "string",
- "podTemplateReference": "string"
}, - "executionNamespace": "string",
- "disableWebhooks": [
- true,
- false
]
}
Download artifact archive
Download the artifact archive from the given execution
path Parameters
environmentId required | string environmentID |
id required | string unique id of the object |
query Parameters
mask | string mask to filter files |
Responses
Response samples
- 404
- 500
[- {
- "title": "Invalid test name",
- "status": 500,
- "detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
}
]
Get execution's artifacts by ID
Returns artifacts of the given executionID
path Parameters
environmentId required | string environmentID |
id required | string unique id of the object |
Responses
Response samples
- 200
- 404
- 500
[- {
- "name": "string",
- "size": 0,
- "executionName": "test-1",
- "status": "ready"
}
]
Download artifact
Download the artifact file from the given execution
path Parameters
environmentId required | string environmentID |
id required | string unique id of the object |
filename required | string filename of the object usually used for artifacts |
Responses
Response samples
- 404
- 500
[- {
- "title": "Invalid test name",
- "status": 500,
- "detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
}
]
Get execution's logs by ID
Returns logs of the given executionID
path Parameters
environmentId required | string environmentID |
id required | string unique id of the object |
Responses
Response samples
- 200
- 500
[- {
- "type": "error",
- "content": "string",
- "result": {
- "status": "queued",
- "output": "string",
- "outputType": "text/plain",
- "errorMessage": "string",
- "steps": [
- {
- "name": "step1",
- "duration": "10m0s",
- "status": "passed",
- "assertionResults": [
- {
- "name": "assertion1",
- "status": "passed",
- "errorMessage": "string"
}
]
}
], - "reports": {
- "junit": "string"
}
}, - "time": "2018-03-20T09:12:28Z"
}
]
Get execution's logs by ID version 2
Returns logs of the given executionID version 2
path Parameters
environmentId required | string environmentID |
id required | string unique id of the object |
Responses
Response samples
- 200
- 500
[- {
- "time": "2018-03-20T09:12:28Z",
- "content": "string",
- "type": "string",
- "source": "job-pod",
- "error": true,
- "version": "v1",
- "metadata": {
- "argsl": "passed command arguments"
}, - "v1": {
- "result": {
- "status": "queued",
- "output": "string",
- "outputType": "text/plain",
- "errorMessage": "string",
- "steps": [
- {
- "name": "step1",
- "duration": "10m0s",
- "status": "passed",
- "assertionResults": [
- {
- "name": "assertion1",
- "status": "passed",
- "errorMessage": "string"
}
]
}
], - "reports": {
- "junit": "string"
}
}
}
}
]