Testkube API (1.0.0)

Download OpenAPI specification:Download

E-mail: testkube@kubeshop.io License: MIT

Testkube provides a Kubernetes-native framework for test definition, execution and results

Find out more about Testkube

api

Testkube API operations

Test triggers keymap

Returns a keymap (supported/allowed fields) for the test trigger UI screen

Responses

Response samples

200

Content type

application/json

{"resources": ["pod",
"deployment",
"statefulset",
"daemonset",
"service",
"ingress",
"event"
],
"actions": ["run"
],
"executions": ["test",
"testsuite"
],
"events": {"pod": ["created",
"modified",
"deleted"
],
"deployment": ["created",
"modified",
"deleted"
]
}
}

List test triggers

List test triggers from the kubernetes cluster

query Parameters

namespace	string Default: "testkube" Namespace of the object
selector	string Labels to filter by

Responses

Response samples

200
502

Content type

application/json

[{"name": "test1",
"namespace": "testkube",
"labels": {"env": "prod",
"app": "backend"
},
"resource": "pod",
"resourceSelector": {"name": "nginx",
"namespace": "testkube",
"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
}
},
"event": "modified",
"action": "run",
"execution": "test",
"testSelector": {"name": "nginx",
"namespace": "testkube",
"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
}
}
}
]

Create new test trigger

Create new test trigger CRD inside a Kubernetes cluster

Request Body schema: application/json

test trigger body

name required	string object name
namespace	string object kubernetes namespace
	object test trigger labels
resource required	string (TestTriggerResources) Enum: "pod" "deployment" "statefulset" "daemonset" "service" "ingress" "event" supported kubernetes resources for test triggers
required	object (TestTriggerSelector)
event required	string listen for event for selected resource
action required	string (TestTriggerActions) Value: "run" supported actions for test triggers
execution required	string (TestTriggerExecutions) Enum: "test" "testsuite" supported test resources for test triggers
required	object (TestTriggerSelector)

Responses

Request samples

Payload

Content type

application/json

{"name": "name",
"namespace": "testkube",
"labels": {"env": "prod",
"app": "backend"
},
"resource": "pod",
"resourceSelector": {"name": "nginx",
"namespace": "testkube",
"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
}
},
"event": "modified",
"action": "run",
"execution": "test",
"testSelector": {"name": "nginx",
"namespace": "testkube",
"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
}
}
}

Response samples

200
400
502

Content type

application/json

{"name": "test1",
"namespace": "testkube",
"labels": {"env": "prod",
"app": "backend"
},
"resource": "pod",
"resourceSelector": {"name": "nginx",
"namespace": "testkube",
"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
}
},
"event": "modified",
"action": "run",
"execution": "test",
"testSelector": {"name": "nginx",
"namespace": "testkube",
"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
}
}
}

Bulk update test triggers

Updates test triggers provided as an array in the request body

Request Body schema: application/json

array of test trigger upsert requests

Array

name required	string object name
namespace	string object kubernetes namespace
	object test trigger labels
resource required	string (TestTriggerResources) Enum: "pod" "deployment" "statefulset" "daemonset" "service" "ingress" "event" supported kubernetes resources for test triggers
required	object (TestTriggerSelector)
event required	string listen for event for selected resource
action required	string (TestTriggerActions) Value: "run" supported actions for test triggers
execution required	string (TestTriggerExecutions) Enum: "test" "testsuite" supported test resources for test triggers
required	object (TestTriggerSelector)

Responses

Request samples

Payload

Content type

application/json

[{"name": "name",
"namespace": "testkube",
"labels": {"env": "prod",
"app": "backend"
},
"resource": "pod",
"resourceSelector": {"name": "nginx",
"namespace": "testkube",
"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
}
},
"event": "modified",
"action": "run",
"execution": "test",
"testSelector": {"name": "nginx",
"namespace": "testkube",
"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
}
}
}
]

Response samples

200
400
502

Content type

application/json

[{"name": "test1",
"namespace": "testkube",
"labels": {"env": "prod",
"app": "backend"
},
"resource": "pod",
"resourceSelector": {"name": "nginx",
"namespace": "testkube",
"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
}
},
"event": "modified",
"action": "run",
"execution": "test",
"testSelector": {"name": "nginx",
"namespace": "testkube",
"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
}
}
}
]

Delete test triggers

Deletes all or labeled test triggers

query Parameters

namespace	string Default: "testkube" Namespace of the object
selector	string Labels to filter by

Responses

Response samples

502

Content type

application/problem+json

[{"type": "https://kubeshop.io/testkube/problems/invalidtestname",
"title": "Invalid test name",
"status": 500,
"detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
"instance": "http://10.23.23.123:8088/tests"
}
]

Get test trigger by ID

Get test trigger by ID from CRD in kubernetes cluster

path Parameters

id

required

string

unique id of the object

query Parameters

namespace

string

Default: "testkube"

Namespace of the object

Responses

Response samples

200
502

Content type

application/json

{"name": "test1",
"namespace": "testkube",
"labels": {"env": "prod",
"app": "backend"
},
"resource": "pod",
"resourceSelector": {"name": "nginx",
"namespace": "testkube",
"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
}
},
"event": "modified",
"action": "run",
"execution": "test",
"testSelector": {"name": "nginx",
"namespace": "testkube",
"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
}
}
}

Update test trigger

path Parameters

id

required

string

unique id of the object

query Parameters

namespace

string

Default: "testkube"

Namespace of the object

Request Body schema: application/json

test trigger upsert request

name required	string object name
namespace	string object kubernetes namespace
	object test trigger labels
resource required	string (TestTriggerResources) Enum: "pod" "deployment" "statefulset" "daemonset" "service" "ingress" "event" supported kubernetes resources for test triggers
required	object (TestTriggerSelector)
event required	string listen for event for selected resource
action required	string (TestTriggerActions) Value: "run" supported actions for test triggers
execution required	string (TestTriggerExecutions) Enum: "test" "testsuite" supported test resources for test triggers
required	object (TestTriggerSelector)

Responses

Request samples

Payload

Content type

application/json

{"name": "name",
"namespace": "testkube",
"labels": {"env": "prod",
"app": "backend"
},
"resource": "pod",
"resourceSelector": {"name": "nginx",
"namespace": "testkube",
"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
}
},
"event": "modified",
"action": "run",
"execution": "test",
"testSelector": {"name": "nginx",
"namespace": "testkube",
"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
}
}
}

Response samples

200
400
502

Content type

application/json

{"name": "test1",
"namespace": "testkube",
"labels": {"env": "prod",
"app": "backend"
},
"resource": "pod",
"resourceSelector": {"name": "nginx",
"namespace": "testkube",
"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
}
},
"event": "modified",
"action": "run",
"execution": "test",
"testSelector": {"name": "nginx",
"namespace": "testkube",
"labelSelector": {"matchExpressions": [{"key": "string",
"operator": "string",
"values": ["string"
]
}
],
"matchLabels": {"property1": "string",
"property2": "string"
}
}
}
}

Delete test trigger

Deletes a test trigger

path Parameters

id

required

string

unique id of the object

query Parameters

namespace

string

Default: "testkube"

Namespace of the object

Responses

Response samples

502

Content type

application/problem+json

[{"type": "https://kubeshop.io/testkube/problems/invalidtestname",
"title": "Invalid test name",
"status": 500,
"detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
"instance": "http://10.23.23.123:8088/tests"
}
]

Create new test suite

Create new test suite action

Request Body schema: application/json

test details body

name required	string object name
namespace required	string object kubernetes namespace
description	string
	Array of objects (TestSuiteStep) Run this step before whole suite
required	Array of objects (TestSuiteStep) Steps to run
	Array of objects (TestSuiteStep) Run this step after whole suite
	object test suite labels
schedule	string schedule to run test suite
repeats	integer Default: 1
created	string <date-time>
	object (TestSuiteExecutionRequest) test suite execution request body

Responses

Request samples

Payload

Content type

application/json

{"name": "name",
"namespace": "testkube",
"description": "collection of tests",
"before": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"steps": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"after": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"repeats": 1,
"created": "2019-08-24T14:15:22Z",
"executionRequest": {"name": "testing with 1000 users",
"number": 1,
"namespace": "testkube",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"labels": {"users": "3",
"prefix": "some-"
},
"executionLabels": {"users": "3",
"prefix": "some-"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"timeout": 1
}
}

Response samples

201
500

Content type

application/json

{"name": "test-suite1",
"namespace": "testkube",
"description": "collection of tests",
"before": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"steps": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"after": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"repeats": 1,
"created": "2019-08-24T14:15:22Z",
"executionRequest": {"name": "testing with 1000 users",
"number": 1,
"namespace": "testkube",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"secretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"labels": {"users": "3",
"prefix": "some-"
},
"executionLabels": {"users": "3",
"prefix": "some-"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"timeout": 1
}
}

Get all test suites

Returns array of test suites

query Parameters

selector	string Labels to filter by
textSearch	string Default: "" text to search in name and test name

Responses

Response samples

200
500

Content type

application/json

[{"name": "test-suite1",
"namespace": "testkube",
"description": "collection of tests",
"before": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"steps": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"after": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"repeats": 1,
"created": "2019-08-24T14:15:22Z",
"executionRequest": {"name": "testing with 1000 users",
"number": 1,
"namespace": "testkube",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"secretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"labels": {"users": "3",
"prefix": "some-"
},
"executionLabels": {"users": "3",
"prefix": "some-"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"timeout": 1
}
}
]

Delete test suites

Deletes all or labeled test suites

query Parameters

selector

string

Labels to filter by

Responses

Response samples

502

Content type

application/problem+json

[{"type": "https://kubeshop.io/testkube/problems/invalidtestname",
"title": "Invalid test name",
"status": 500,
"detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
"instance": "http://10.23.23.123:8088/tests"
}
]

Get test suite by ID

Returns test suite with given name

path Parameters

id

required

string

unique id of the object

Responses

Response samples

200
500

Content type

application/json

{"name": "test-suite1",
"namespace": "testkube",
"description": "collection of tests",
"before": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"steps": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"after": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"repeats": 1,
"created": "2019-08-24T14:15:22Z",
"executionRequest": {"name": "testing with 1000 users",
"number": 1,
"namespace": "testkube",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"secretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"labels": {"users": "3",
"prefix": "some-"
},
"executionLabels": {"users": "3",
"prefix": "some-"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"timeout": 1
}
}

Update test suite

Update test based on test suite content or git based data

path Parameters

id

required

string

unique id of the object

Request Body schema: application/json

test suite details body

name required	string object name
namespace required	string object kubernetes namespace
description	string
	Array of objects (TestSuiteStep) Run this step before whole suite
required	Array of objects (TestSuiteStep) Steps to run
	Array of objects (TestSuiteStep) Run this step after whole suite
	object test suite labels
schedule	string schedule to run test suite
repeats	integer Default: 1
created	string <date-time>
	object (TestSuiteExecutionRequest) test suite execution request body

Responses

Request samples

Payload

Content type

application/json

{"name": "name",
"namespace": "testkube",
"description": "collection of tests",
"before": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"steps": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"after": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"repeats": 1,
"created": "2019-08-24T14:15:22Z",
"executionRequest": {"name": "testing with 1000 users",
"number": 1,
"namespace": "testkube",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"labels": {"users": "3",
"prefix": "some-"
},
"executionLabels": {"users": "3",
"prefix": "some-"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"timeout": 1
}
}

Response samples

200
400
502

Content type

application/json

{"name": "test-suite1",
"namespace": "testkube",
"description": "collection of tests",
"before": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"steps": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"after": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"repeats": 1,
"created": "2019-08-24T14:15:22Z",
"executionRequest": {"name": "testing with 1000 users",
"number": 1,
"namespace": "testkube",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"secretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"labels": {"users": "3",
"prefix": "some-"
},
"executionLabels": {"users": "3",
"prefix": "some-"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"timeout": 1
}
}

Delete test suite

Deletes a test suite

path Parameters

id

required

string

unique id of the object

Responses

Response samples

502

Content type

application/problem+json

[{"type": "https://kubeshop.io/testkube/problems/invalidtestname",
"title": "Invalid test name",
"status": 500,
"detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
"instance": "http://10.23.23.123:8088/tests"
}
]

Get test suite metrics

Gets test suite metrics for given tests executions, with particular execution status and timings

path Parameters

id

required

string

unique id of the object

query Parameters

last	integer Default: 7 last N days to show
limit	integer Default: 7 limit records count same as pageSize

Responses

Response samples

200
502

Content type

application/json

{"passFailRatio": 50,
"executionDurationP50": "7m2.71s",
"executionDurationP50ms": 422,
"executionDurationP90": "7m2.71s",
"executionDurationP90ms": 422,
"executionDurationP95": "7m2.71s",
"executionDurationP95ms": 422,
"executionDurationP99": "7m2.71s",
"executionDurationP99ms": 422,
"totalExecutions": 2,
"failedExecutions": 1,
"executions": [{"executionId": "string",
"duration": "string",
"durationMs": 0,
"status": "string",
"name": "string",
"startTime": "2019-08-24T14:15:22Z"
}
]
}

List tests for test suite

List available tests for test suite

path Parameters

id

required

string

unique id of the object

Responses

Response samples

200
502

Content type

application/json

[{"name": "test1",
"namespace": "testkube",
"type": "postman/collection",
"content": {"type": "string",
"repository": {"type": "git",
"uri": "https://github.com/kubeshop/testkube",
"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"
},
"workingDir": "/"
},
"data": "string",
"uri": "https://github.com/kubeshop/testkube"
},
"source": "my-private-repository-test",
"created": "2022-07-30T06:54:15Z",
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"uploads": ["settings/config.txt"
],
"executionRequest": {"name": "testing with 1000 users",
"testSuiteName": "test-suite1",
"number": 0,
"executionLabels": {"users": "3",
"prefix": "some-"
},
"namespace": "testkube",
"variablesFile": "string",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"command": ["curl"
],
"args": ["--repeats",
"5",
"--insecure"
],
"image": "kubeshop/testkube-executor-custom:1.10.11-dev-0a9c91",
"imagePullSecrets": [{"name": "string"
}
],
"envs": {"record": "true",
"prefix": "some-"
},
"secretEnvs": {"secret_key_name1": "secret-name",
"secret_Key_name2": "secret-name"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"activeDeadlineSeconds": 1,
"uploads": ["settings/config.txt"
],
"bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
"artifactRequest": {"storageClassName": "artifact-volume-local",
"volumeMountPath": "string",
"dirs": ["string"
]
},
"jobTemplate": "string"
}
}
]

Get all test suite with executions

Returns array of test suite with executions

query Parameters

selector	string Labels to filter by
textSearch	string Default: "" text to search in name and test name
status	string (TestSuiteExecutionStatus) Enum: "queued" "running" "passed" "failed" "aborting" "aborted" "timeout" optional status filter containing multiple values separated by comma
pageSize	integer Default: 100 the number of executions to get, setting to 0 will return only totals
page	integer Default: 0 the page index to start at

Responses

Response samples

200
500

Content type

application/json

[{"testSuite": {"name": "test-suite1",
"namespace": "testkube",
"description": "collection of tests",
"before": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"steps": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"after": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"repeats": 1,
"created": "2019-08-24T14:15:22Z",
"executionRequest": {"name": "testing with 1000 users",
"number": 1,
"namespace": "testkube",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"secretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"labels": {"users": "3",
"prefix": "some-"
},
"executionLabels": {"users": "3",
"prefix": "some-"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"timeout": 1
}
},
"latestExecution": {"id": "62f395e004109209b50edfc1",
"name": "test-suite1.needlessly-sweet-imp",
"testSuiteName": "test-suite1",
"status": "queued",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"duration": "00:00:09",
"durationMs": 9009,
"execution": [{"id": "62f395e004109209b50edfc4",
"name": "run:testkube/test1",
"testName": "test1",
"status": "queued",
"type": "executeTest"
}
],
"labels": {"env": "prod",
"app": "backend"
}
}
}
]

Get test suite by ID with execution

Returns test suite with given name with execution

path Parameters

id

required

string

unique id of the object

Responses

Response samples

200
500

Content type

application/json

{"testSuite": {"name": "test-suite1",
"namespace": "testkube",
"description": "collection of tests",
"before": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"steps": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"after": [{"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "example-test"
}
}
],
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"repeats": 1,
"created": "2019-08-24T14:15:22Z",
"executionRequest": {"name": "testing with 1000 users",
"number": 1,
"namespace": "testkube",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"secretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"labels": {"users": "3",
"prefix": "some-"
},
"executionLabels": {"users": "3",
"prefix": "some-"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"timeout": 1
}
},
"latestExecution": {"id": "62f395e004109209b50edfc1",
"name": "test-suite1.needlessly-sweet-imp",
"testSuite": {"namespace": "testkube",
"name": "name"
},
"status": "queued",
"envs": {"record": "true",
"prefix": "some-"
},
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"secretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"duration": "2m",
"durationMs": 6000,
"stepResults": [{"step": {"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "name"
},
"delay": {"duration": 0
}
},
"test": {"namespace": "testkube",
"name": "name"
},
"execution": {"id": "62f395e004109209b50edfc4",
"testName": "example-test",
"testSuiteName": "test-suite1",
"testNamespace": "testkube",
"testType": "postman/collection",
"name": "test-suite1-example-test-1",
"number": 1,
"envs": {"record": "true",
"prefix": "some-"
},
"args": ["--concurrency",
"2",
"--remote",
"--some",
"blabla"
],
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"variablesFile": "string",
"testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"content": {"type": "string",
"repository": {"type": "git",
"uri": "https://github.com/kubeshop/testkube",
"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"
},
"workingDir": "/"
},
"data": "string",
"uri": "https://github.com/kubeshop/testkube"
},
"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": null,
"status": null,
"errorMessage": null
}
]
}
],
"reports": {"junit": "string"
}
},
"labels": {"env": "prod",
"app": "backend"
},
"uploads": ["settings/config.txt"
],
"bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
"artifactRequest": {"storageClassName": "artifact-volume-local",
"volumeMountPath": "string",
"dirs": ["string"
]
}
}
}
],
"labels": {"env": "prod",
"app": "backend"
}
}
}

Starts new test suite execution

New test suite execution returns new execution details on successful execution start

path Parameters

id

required

string

unique id of the object

query Parameters

namespace	string Default: "testkube" Namespace of the object
last	integer Default: 7 last N days to show

Request Body schema: application/json

body passed to configure execution

name	string test execution custom name
number	integer test suite execution number
namespace	string test kubernetes namespace ("testkube" when not set)
	object (Variables) execution variables passed to executor converted to vars for usage in tests
	object test suite labels
	object execution labels
sync	boolean whether to start execution sync or async
httpProxy	string http proxy for executor containers
httpsProxy	string https proxy for executor containers
timeout	integer <int32> duration in seconds the test suite may be active, until its stopped

Responses

Request samples

Payload

Content type

application/json

{"name": "testing with 1000 users",
"number": 1,
"namespace": "testkube",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"labels": {"users": "3",
"prefix": "some-"
},
"executionLabels": {"users": "3",
"prefix": "some-"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"timeout": 1
}

Response samples

201
400
500
502

Content type

application/json

{"totals": {"results": 0,
"passed": 0,
"failed": 0,
"queued": 0,
"running": 0
},
"filtered": {"results": 0,
"passed": 0,
"failed": 0,
"queued": 0,
"running": 0
},
"results": [{"id": "62f395e004109209b50edfc1",
"name": "test-suite1.needlessly-sweet-imp",
"testSuiteName": "test-suite1",
"status": "queued",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"duration": "00:00:09",
"durationMs": 9009,
"execution": [{"id": "62f395e004109209b50edfc4",
"name": "run:testkube/test1",
"testName": "test1",
"status": "queued",
"type": "executeTest"
}
],
"labels": {"env": "prod",
"app": "backend"
}
}
]
}

Get all test suite executions

Returns array of all available test suite executions

path Parameters

id

required

string

unique id of the object

query Parameters

pageSize	integer Default: 100 the number of executions to get, setting to 0 will return only totals
page	integer Default: 0 the page index to start at
status	string (TestSuiteExecutionStatus) Enum: "queued" "running" "passed" "failed" "aborting" "aborted" "timeout" 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

Responses

Response samples

200
500

Content type

application/json

{"totals": {"results": 0,
"passed": 0,
"failed": 0,
"queued": 0,
"running": 0
},
"filtered": {"results": 0,
"passed": 0,
"failed": 0,
"queued": 0,
"running": 0
},
"results": [{"id": "62f395e004109209b50edfc1",
"name": "test-suite1.needlessly-sweet-imp",
"testSuiteName": "test-suite1",
"status": "queued",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"duration": "00:00:09",
"durationMs": 9009,
"execution": [{"id": "62f395e004109209b50edfc4",
"name": "run:testkube/test1",
"testName": "test1",
"status": "queued",
"type": "executeTest"
}
],
"labels": {"env": "prod",
"app": "backend"
}
}
]
}

Get test suite execution

Returns test suite execution with given executionID

path Parameters

id required	string unique id of the object
executionID required	string unique id of the object execution

Responses

Response samples

200
500

Content type

application/json

{"id": "62f395e004109209b50edfc1",
"name": "test-suite1.needlessly-sweet-imp",
"testSuite": {"namespace": "testkube",
"name": "name"
},
"status": "queued",
"envs": {"record": "true",
"prefix": "some-"
},
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"secretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"duration": "2m",
"durationMs": 6000,
"stepResults": [{"step": {"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "name"
},
"delay": {"duration": 0
}
},
"test": {"namespace": "testkube",
"name": "name"
},
"execution": {"id": "62f395e004109209b50edfc4",
"testName": "example-test",
"testSuiteName": "test-suite1",
"testNamespace": "testkube",
"testType": "postman/collection",
"name": "test-suite1-example-test-1",
"number": 1,
"envs": {"record": "true",
"prefix": "some-"
},
"args": ["--concurrency",
"2",
"--remote",
"--some",
"blabla"
],
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"variablesFile": "string",
"testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"content": {"type": "string",
"repository": {"type": "git",
"uri": "https://github.com/kubeshop/testkube",
"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"
},
"workingDir": "/"
},
"data": "string",
"uri": "https://github.com/kubeshop/testkube"
},
"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": {"env": "prod",
"app": "backend"
},
"uploads": ["settings/config.txt"
],
"bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
"artifactRequest": {"storageClassName": "artifact-volume-local",
"volumeMountPath": "string",
"dirs": ["string"
]
}
}
}
],
"labels": {"env": "prod",
"app": "backend"
}
}

Aborts testsuite execution

Aborts testsuite execution with given executionID

path Parameters

id required	string unique id of the object
executionID required	string unique id of the object execution

Responses

Response samples

502

Content type

application/problem+json

[{"type": "https://kubeshop.io/testkube/problems/invalidtestname",
"title": "Invalid test name",
"status": 500,
"detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
"instance": "http://10.23.23.123:8088/tests"
}
]

Starts new test suite executions

New test suite executions returns new executions details on successful executions start

query Parameters

namespace	string Default: "testkube" Namespace of the object
selector	string Labels to filter by
concurrency	integer Default: 10

Request Body schema: application/json

body passed to configure executions

name	string test execution custom name
number	integer test suite execution number
namespace	string test kubernetes namespace ("testkube" when not set)
	object (Variables) execution variables passed to executor converted to vars for usage in tests
	object test suite labels
	object execution labels
sync	boolean whether to start execution sync or async
httpProxy	string http proxy for executor containers
httpsProxy	string https proxy for executor containers
timeout	integer <int32> duration in seconds the test suite may be active, until its stopped

Responses

Request samples

Payload

Content type

application/json

{"name": "testing with 1000 users",
"number": 1,
"namespace": "testkube",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"labels": {"users": "3",
"prefix": "some-"
},
"executionLabels": {"users": "3",
"prefix": "some-"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"timeout": 1
}

Response samples

201
400
500
502

Content type

application/json

[{"totals": {"results": 0,
"passed": 0,
"failed": 0,
"queued": 0,
"running": 0
},
"filtered": {"results": 0,
"passed": 0,
"failed": 0,
"queued": 0,
"running": 0
},
"results": [{"id": "62f395e004109209b50edfc1",
"name": "test-suite1.needlessly-sweet-imp",
"testSuiteName": "test-suite1",
"status": "queued",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"duration": "00:00:09",
"durationMs": 9009,
"execution": [{"id": "62f395e004109209b50edfc4",
"name": "run:testkube/test1",
"testName": "test1",
"status": "queued",
"type": "executeTest"
}
],
"labels": {"env": "prod",
"app": "backend"
}
}
]
}
]

Get all test suite executions

Returns array of test suite executions

query Parameters

last	integer Default: 7 last N days to show
test	string Default: "" test namespaced name to filter
textSearch	string Default: "" text to search in name and test name
pageSize	integer Default: 100 the number of executions to get, setting to 0 will return only totals
page	integer Default: 0 the page index to start at
status	string (TestSuiteExecutionStatus) Enum: "queued" "running" "passed" "failed" "aborting" "aborted" "timeout" 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 Labels to filter by

Responses

Response samples

200
500

Content type

application/json

{"totals": {"results": 0,
"passed": 0,
"failed": 0,
"queued": 0,
"running": 0
},
"filtered": {"results": 0,
"passed": 0,
"failed": 0,
"queued": 0,
"running": 0
},
"results": [{"id": "62f395e004109209b50edfc1",
"name": "test-suite1.needlessly-sweet-imp",
"testSuiteName": "test-suite1",
"status": "queued",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"duration": "00:00:09",
"durationMs": 9009,
"execution": [{"id": "62f395e004109209b50edfc4",
"name": "run:testkube/test1",
"testName": "test1",
"status": "queued",
"type": "executeTest"
}
],
"labels": {"env": "prod",
"app": "backend"
}
}
]
}

Get test suite execution by ID

Returns test suite execution with given executionID

path Parameters

executionID

required

string

unique id of the object execution

query Parameters

last	integer Default: 7 last N days to show

Responses

Response samples

200
500

Content type

application/json

{"id": "62f395e004109209b50edfc1",
"name": "test-suite1.needlessly-sweet-imp",
"testSuite": {"namespace": "testkube",
"name": "name"
},
"status": "queued",
"envs": {"record": "true",
"prefix": "some-"
},
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"secretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"duration": "2m",
"durationMs": 6000,
"stepResults": [{"step": {"stopTestOnFailure": true,
"execute": {"namespace": "testkube",
"name": "name"
},
"delay": {"duration": 0
}
},
"test": {"namespace": "testkube",
"name": "name"
},
"execution": {"id": "62f395e004109209b50edfc4",
"testName": "example-test",
"testSuiteName": "test-suite1",
"testNamespace": "testkube",
"testType": "postman/collection",
"name": "test-suite1-example-test-1",
"number": 1,
"envs": {"record": "true",
"prefix": "some-"
},
"args": ["--concurrency",
"2",
"--remote",
"--some",
"blabla"
],
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"variablesFile": "string",
"testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"content": {"type": "string",
"repository": {"type": "git",
"uri": "https://github.com/kubeshop/testkube",
"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"
},
"workingDir": "/"
},
"data": "string",
"uri": "https://github.com/kubeshop/testkube"
},
"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": {"env": "prod",
"app": "backend"
},
"uploads": ["settings/config.txt"
],
"bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
"artifactRequest": {"storageClassName": "artifact-volume-local",
"volumeMountPath": "string",
"dirs": ["string"
]
}
}
}
],
"labels": {"env": "prod",
"app": "backend"
}
}

Aborts testsuite execution

Aborts testsuite execution with given executionID

path Parameters

executionID

required

string

unique id of the object execution

Responses

Response samples

502

Content type

application/problem+json

[{"type": "https://kubeshop.io/testkube/problems/invalidtestname",
"title": "Invalid test name",
"status": 500,
"detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
"instance": "http://10.23.23.123:8088/tests"
}
]

Starts new test executions

New test executions returns new executions details on successful executions start

query Parameters

namespace	string Default: "testkube" Namespace of the object
selector	string Labels to filter by
executionSelector	string Execution Labels to add to executions
concurrency	integer Default: 10

Request Body schema: application/json

body passed to configure executions

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)
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
command	Array of strings container executor image command
args	Array of strings additional executor binary arguments
image	string container image, executor will run inside this image
	Array of objects (LocalObjectReference) container image pull secrets
	object environment variables passed to executor
	object execution variables passed to executor from secrets
sync	boolean whether to start execution sync or async
httpProxy	string http proxy for executor containers
httpsProxy	string https proxy for executor containers
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 for container executors with test artifacts
jobTemplate	string job template extensions

Responses

Request samples

Payload

Content type

application/json

{"name": "testing with 1000 users",
"testSuiteName": "test-suite1",
"number": 0,
"executionLabels": {"users": "3",
"prefix": "some-"
},
"namespace": "testkube",
"variablesFile": "string",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"command": ["curl"
],
"args": ["--repeats",
"5",
"--insecure"
],
"image": "kubeshop/testkube-executor-custom:1.10.11-dev-0a9c91",
"imagePullSecrets": [{"name": "string"
}
],
"envs": {"record": "true",
"prefix": "some-"
},
"secretEnvs": {"secret_key_name1": "secret-name",
"secret_Key_name2": "secret-name"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"activeDeadlineSeconds": 1,
"uploads": ["settings/config.txt"
],
"bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
"artifactRequest": {"storageClassName": "artifact-volume-local",
"volumeMountPath": "string",
"dirs": ["string"
]
},
"jobTemplate": "string"
}

Response samples

201
400
500
502

Content type

application/json

[{"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 all test executions

Returns array of test executions

query Parameters

test	string Default: "" test namespaced name to filter
type	string Default: "" object type
textSearch	string Default: "" text to search in name and test name
pageSize	integer Default: 100 the number of executions to get, setting to 0 will return only totals
page	integer Default: 0 the page index to start at
status	string (ExecutionStatus) Enum: "queued" "running" "passed" "failed" "aborted" "timeout" 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 Labels to filter by

Responses

Response samples

200
500

Content type

application/json

{"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": {"env": "prod",
"app": "backend"
}
}
]
}

Get test execution by ID

Returns execution with given executionID

path Parameters

executionID

required

string

unique id of the object execution

Responses

Response samples

200
500

Content type

application/json

{"id": "62f395e004109209b50edfc4",
"testName": "example-test",
"testSuiteName": "test-suite1",
"testNamespace": "testkube",
"testType": "postman/collection",
"name": "test-suite1-example-test-1",
"number": 1,
"envs": {"record": "true",
"prefix": "some-"
},
"args": ["--concurrency",
"2",
"--remote",
"--some",
"blabla"
],
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"variablesFile": "string",
"testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"content": {"type": "string",
"repository": {"type": "git",
"uri": "https://github.com/kubeshop/testkube",
"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"
},
"workingDir": "/"
},
"data": "string",
"uri": "https://github.com/kubeshop/testkube"
},
"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": {"env": "prod",
"app": "backend"
},
"uploads": ["settings/config.txt"
],
"bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
"artifactRequest": {"storageClassName": "artifact-volume-local",
"volumeMountPath": "string",
"dirs": ["string"
]
}
}

Get execution's artifacts by ID

Returns artifacts of the given executionID

path Parameters

id

required

string

unique id of the object

Responses

Response samples

200
500

Content type

application/json

[{"name": "string",
"size": 0
}
]

Get execution's logs by ID

Returns logs of the given executionID

path Parameters

id

required

string

unique id of the object

Responses

Response samples

200
500

Content type

application/json

[{"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"
}
}
}
]

Download artifact

Download the artifact file from the given execution

path Parameters

id required	string unique id of the object
filename required	string filename of the object usually used for artifacts

Responses

Response samples

500

Content type

application/problem+json

[{"type": "https://kubeshop.io/testkube/problems/invalidtestname",
"title": "Invalid test name",
"status": 500,
"detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
"instance": "http://10.23.23.123:8088/tests"
}
]

List tests

List available tests

query Parameters

selector	string Labels to filter by
textSearch	string Default: "" text to search in name and test name

Responses

Response samples

200
502

Content type

application/json

[{"name": "test1",
"namespace": "testkube",
"type": "postman/collection",
"content": {"type": "string",
"repository": {"type": "git",
"uri": "https://github.com/kubeshop/testkube",
"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"
},
"workingDir": "/"
},
"data": "string",
"uri": "https://github.com/kubeshop/testkube"
},
"source": "my-private-repository-test",
"created": "2022-07-30T06:54:15Z",
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"uploads": ["settings/config.txt"
],
"executionRequest": {"name": "testing with 1000 users",
"testSuiteName": "test-suite1",
"number": 0,
"executionLabels": {"users": "3",
"prefix": "some-"
},
"namespace": "testkube",
"variablesFile": "string",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"command": ["curl"
],
"args": ["--repeats",
"5",
"--insecure"
],
"image": "kubeshop/testkube-executor-custom:1.10.11-dev-0a9c91",
"imagePullSecrets": [{"name": "string"
}
],
"envs": {"record": "true",
"prefix": "some-"
},
"secretEnvs": {"secret_key_name1": "secret-name",
"secret_Key_name2": "secret-name"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"activeDeadlineSeconds": 1,
"uploads": ["settings/config.txt"
],
"bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
"artifactRequest": {"storageClassName": "artifact-volume-local",
"volumeMountPath": "string",
"dirs": ["string"
]
},
"jobTemplate": "string"
}
}
]

Create new test

Create new test based on file content, uri or git based data

Request Body schema: application/json

test details body

name	string test name
namespace	string test namespace
type	string test type
	object (TestContent)
source	string reference to test source resource
created	string <date-time>
	object test labels
schedule	string schedule to run test
uploads	Array of strings list of file paths that will be needed from uploads
	object (ExecutionRequest) test execution request body

Responses

Request samples

Payload

Content type

application/json

{"name": "test1",
"namespace": "testkube",
"type": "postman/collection",
"content": {"type": "string",
"repository": {"type": "git",
"uri": "https://github.com/kubeshop/testkube",
"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"
},
"workingDir": "/"
},
"data": "string",
"uri": "https://github.com/kubeshop/testkube"
},
"source": "my-private-repository-test",
"created": "2022-07-30T06:54:15Z",
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"uploads": ["settings/config.txt"
],
"executionRequest": {"name": "testing with 1000 users",
"testSuiteName": "test-suite1",
"number": 0,
"executionLabels": {"users": "3",
"prefix": "some-"
},
"namespace": "testkube",
"variablesFile": "string",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"command": ["curl"
],
"args": ["--repeats",
"5",
"--insecure"
],
"image": "kubeshop/testkube-executor-custom:1.10.11-dev-0a9c91",
"imagePullSecrets": [{"name": "string"
}
],
"envs": {"record": "true",
"prefix": "some-"
},
"secretEnvs": {"secret_key_name1": "secret-name",
"secret_Key_name2": "secret-name"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"activeDeadlineSeconds": 1,
"uploads": ["settings/config.txt"
],
"bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
"artifactRequest": {"storageClassName": "artifact-volume-local",
"volumeMountPath": "string",
"dirs": ["string"
]
},
"jobTemplate": "string"
}
}

Response samples

201
400
502

Content type

application/json

{"name": "test1",
"namespace": "testkube",
"type": "postman/collection",
"content": {"type": "string",
"repository": {"type": "git",
"uri": "https://github.com/kubeshop/testkube",
"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"
},
"workingDir": "/"
},
"data": "string",
"uri": "https://github.com/kubeshop/testkube"
},
"source": "my-private-repository-test",
"created": "2022-07-30T06:54:15Z",
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"uploads": ["settings/config.txt"
],
"executionRequest": {"name": "testing with 1000 users",
"testSuiteName": "test-suite1",
"number": 0,
"executionLabels": {"users": "3",
"prefix": "some-"
},
"namespace": "testkube",
"variablesFile": "string",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"command": ["curl"
],
"args": ["--repeats",
"5",
"--insecure"
],
"image": "kubeshop/testkube-executor-custom:1.10.11-dev-0a9c91",
"imagePullSecrets": [{"name": "string"
}
],
"envs": {"record": "true",
"prefix": "some-"
},
"secretEnvs": {"secret_key_name1": "secret-name",
"secret_Key_name2": "secret-name"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"activeDeadlineSeconds": 1,
"uploads": ["settings/config.txt"
],
"bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
"artifactRequest": {"storageClassName": "artifact-volume-local",
"volumeMountPath": "string",
"dirs": ["string"
]
},
"jobTemplate": "string"
}
}

Delete tests

Deletes all or labeled tests

query Parameters

selector

string

Labels to filter by

Responses

Response samples

502

Content type

application/problem+json

[{"type": "https://kubeshop.io/testkube/problems/invalidtestname",
"title": "Invalid test name",
"status": 500,
"detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
"instance": "http://10.23.23.123:8088/tests"
}
]

Update test

Update test based on test content or git based data

path Parameters

id

required

string

unique id of the object

Request Body schema: application/json

test details body

name	string test name
namespace	string test namespace
type	string test type
	object (TestContent)
source	string reference to test source resource
created	string <date-time>
	object test labels
schedule	string schedule to run test
uploads	Array of strings list of file paths that will be needed from uploads
	object (ExecutionRequest) test execution request body

Responses

Request samples

Payload

Content type

application/json

{"name": "test1",
"namespace": "testkube",
"type": "postman/collection",
"content": {"type": "string",
"repository": {"type": "git",
"uri": "https://github.com/kubeshop/testkube",
"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"
},
"workingDir": "/"
},
"data": "string",
"uri": "https://github.com/kubeshop/testkube"
},
"source": "my-private-repository-test",
"created": "2022-07-30T06:54:15Z",
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"uploads": ["settings/config.txt"
],
"executionRequest": {"name": "testing with 1000 users",
"testSuiteName": "test-suite1",
"number": 0,
"executionLabels": {"users": "3",
"prefix": "some-"
},
"namespace": "testkube",
"variablesFile": "string",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"command": ["curl"
],
"args": ["--repeats",
"5",
"--insecure"
],
"image": "kubeshop/testkube-executor-custom:1.10.11-dev-0a9c91",
"imagePullSecrets": [{"name": "string"
}
],
"envs": {"record": "true",
"prefix": "some-"
},
"secretEnvs": {"secret_key_name1": "secret-name",
"secret_Key_name2": "secret-name"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"activeDeadlineSeconds": 1,
"uploads": ["settings/config.txt"
],
"bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
"artifactRequest": {"storageClassName": "artifact-volume-local",
"volumeMountPath": "string",
"dirs": ["string"
]
},
"jobTemplate": "string"
}
}

Response samples

200
400
502

Content type

application/json

{"name": "test1",
"namespace": "testkube",
"type": "postman/collection",
"content": {"type": "string",
"repository": {"type": "git",
"uri": "https://github.com/kubeshop/testkube",
"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"
},
"workingDir": "/"
},
"data": "string",
"uri": "https://github.com/kubeshop/testkube"
},
"source": "my-private-repository-test",
"created": "2022-07-30T06:54:15Z",
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"uploads": ["settings/config.txt"
],
"executionRequest": {"name": "testing with 1000 users",
"testSuiteName": "test-suite1",
"number": 0,
"executionLabels": {"users": "3",
"prefix": "some-"
},
"namespace": "testkube",
"variablesFile": "string",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"command": ["curl"
],
"args": ["--repeats",
"5",
"--insecure"
],
"image": "kubeshop/testkube-executor-custom:1.10.11-dev-0a9c91",
"imagePullSecrets": [{"name": "string"
}
],
"envs": {"record": "true",
"prefix": "some-"
},
"secretEnvs": {"secret_key_name1": "secret-name",
"secret_Key_name2": "secret-name"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"activeDeadlineSeconds": 1,
"uploads": ["settings/config.txt"
],
"bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
"artifactRequest": {"storageClassName": "artifact-volume-local",
"volumeMountPath": "string",
"dirs": ["string"
]
},
"jobTemplate": "string"
}
}

Get test

Gets the specified test

path Parameters

id

required

string

unique id of the object

Responses

Response samples

200
502

Content type

application/json

{"name": "test1",
"namespace": "testkube",
"type": "postman/collection",
"content": {"type": "string",
"repository": {"type": "git",
"uri": "https://github.com/kubeshop/testkube",
"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"
},
"workingDir": "/"
},
"data": "string",
"uri": "https://github.com/kubeshop/testkube"
},
"source": "my-private-repository-test",
"created": "2022-07-30T06:54:15Z",
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"uploads": ["settings/config.txt"
],
"executionRequest": {"name": "testing with 1000 users",
"testSuiteName": "test-suite1",
"number": 0,
"executionLabels": {"users": "3",
"prefix": "some-"
},
"namespace": "testkube",
"variablesFile": "string",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"command": ["curl"
],
"args": ["--repeats",
"5",
"--insecure"
],
"image": "kubeshop/testkube-executor-custom:1.10.11-dev-0a9c91",
"imagePullSecrets": [{"name": "string"
}
],
"envs": {"record": "true",
"prefix": "some-"
},
"secretEnvs": {"secret_key_name1": "secret-name",
"secret_Key_name2": "secret-name"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"activeDeadlineSeconds": 1,
"uploads": ["settings/config.txt"
],
"bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
"artifactRequest": {"storageClassName": "artifact-volume-local",
"volumeMountPath": "string",
"dirs": ["string"
]
},
"jobTemplate": "string"
}
}

Delete test

Deletes a test

path Parameters

id

required

string

unique id of the object

Responses

Response samples

502

Content type

application/problem+json

[{"type": "https://kubeshop.io/testkube/problems/invalidtestname",
"title": "Invalid test name",
"status": 500,
"detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
"instance": "http://10.23.23.123:8088/tests"
}
]

Get test metrics

Gets test metrics for given tests executions, with particular execution status and timings

path Parameters

id

required

string

unique id of the object

query Parameters

last	integer Default: 7 last N days to show
limit	integer Default: 7 limit records count same as pageSize

Responses

Response samples

200
502

Content type

application/json

{"passFailRatio": 50,
"executionDurationP50": "7m2.71s",
"executionDurationP50ms": 422,
"executionDurationP90": "7m2.71s",
"executionDurationP90ms": 422,
"executionDurationP95": "7m2.71s",
"executionDurationP95ms": 422,
"executionDurationP99": "7m2.71s",
"executionDurationP99ms": 422,
"totalExecutions": 2,
"failedExecutions": 1,
"executions": [{"executionId": "string",
"duration": "string",
"durationMs": 0,
"status": "string",
"name": "string",
"startTime": "2019-08-24T14:15:22Z"
}
]
}

List test with executions

List available test with executions

query Parameters

selector	string Labels to filter by
textSearch	string Default: "" text to search in name and test name
status	string (ExecutionStatus) Enum: "queued" "running" "passed" "failed" "aborted" "timeout" optional status filter containing multiple values separated by comma
pageSize	integer Default: 100 the number of executions to get, setting to 0 will return only totals
page	integer Default: 0 the page index to start at

Responses

Response samples

200
502

Content type

application/json

[{"test": {"name": "test1",
"namespace": "testkube",
"type": "postman/collection",
"content": {"type": "string",
"repository": {"type": "git",
"uri": "https://github.com/kubeshop/testkube",
"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"
},
"workingDir": "/"
},
"data": "string",
"uri": "https://github.com/kubeshop/testkube"
},
"source": "my-private-repository-test",
"created": "2022-07-30T06:54:15Z",
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"uploads": ["settings/config.txt"
],
"executionRequest": {"name": "testing with 1000 users",
"testSuiteName": "test-suite1",
"number": 0,
"executionLabels": {"users": "3",
"prefix": "some-"
},
"namespace": "testkube",
"variablesFile": "string",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"command": ["curl"
],
"args": ["--repeats",
"5",
"--insecure"
],
"image": "kubeshop/testkube-executor-custom:1.10.11-dev-0a9c91",
"imagePullSecrets": [{"name": "string"
}
],
"envs": {"record": "true",
"prefix": "some-"
},
"secretEnvs": {"secret_key_name1": "secret-name",
"secret_Key_name2": "secret-name"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"activeDeadlineSeconds": 1,
"uploads": ["settings/config.txt"
],
"bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
"artifactRequest": {"storageClassName": "artifact-volume-local",
"volumeMountPath": "string",
"dirs": ["string"
]
},
"jobTemplate": "string"
}
},
"latestExecution": {"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": {"env": "prod",
"app": "backend"
}
}
}
]

Get test with execution

Gets the specified test with execution

path Parameters

id

required

string

unique id of the object

Responses

Response samples

200
502

Content type

application/json

{"test": {"name": "test1",
"namespace": "testkube",
"type": "postman/collection",
"content": {"type": "string",
"repository": {"type": "git",
"uri": "https://github.com/kubeshop/testkube",
"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"
},
"workingDir": "/"
},
"data": "string",
"uri": "https://github.com/kubeshop/testkube"
},
"source": "my-private-repository-test",
"created": "2022-07-30T06:54:15Z",
"labels": {"env": "prod",
"app": "backend"
},
"schedule": "* * * * *",
"uploads": ["settings/config.txt"
],
"executionRequest": {"name": "testing with 1000 users",
"testSuiteName": "test-suite1",
"number": 0,
"executionLabels": {"users": "3",
"prefix": "some-"
},
"namespace": "testkube",
"variablesFile": "string",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"command": ["curl"
],
"args": ["--repeats",
"5",
"--insecure"
],
"image": "kubeshop/testkube-executor-custom:1.10.11-dev-0a9c91",
"imagePullSecrets": [{"name": "string"
}
],
"envs": {"record": "true",
"prefix": "some-"
},
"secretEnvs": {"secret_key_name1": "secret-name",
"secret_Key_name2": "secret-name"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"activeDeadlineSeconds": 1,
"uploads": ["settings/config.txt"
],
"bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
"artifactRequest": {"storageClassName": "artifact-volume-local",
"volumeMountPath": "string",
"dirs": ["string"
]
},
"jobTemplate": "string"
}
},
"latestExecution": {"id": "62f395e004109209b50edfc4",
"testName": "example-test",
"testSuiteName": "test-suite1",
"testNamespace": "testkube",
"testType": "postman/collection",
"name": "test-suite1-example-test-1",
"number": 1,
"envs": {"record": "true",
"prefix": "some-"
},
"args": ["--concurrency",
"2",
"--remote",
"--some",
"blabla"
],
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"variablesFile": "string",
"testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"testSuiteSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"content": {"type": "string",
"repository": {"type": "git",
"uri": "https://github.com/kubeshop/testkube",
"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"
},
"workingDir": "/"
},
"data": "string",
"uri": "https://github.com/kubeshop/testkube"
},
"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": {"env": "prod",
"app": "backend"
},
"uploads": ["settings/config.txt"
],
"bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
"artifactRequest": {"storageClassName": "artifact-volume-local",
"volumeMountPath": "string",
"dirs": ["string"
]
}
}
}

Starts new test execution

New test execution returns new execution details on successful execution start

path Parameters

id

required

string

unique id of the object

query Parameters

namespace

string

Default: "testkube"

Namespace of the object

Request Body schema: application/json

body passed to configure execution

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)
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
command	Array of strings container executor image command
args	Array of strings additional executor binary arguments
image	string container image, executor will run inside this image
	Array of objects (LocalObjectReference) container image pull secrets
	object environment variables passed to executor
	object execution variables passed to executor from secrets
sync	boolean whether to start execution sync or async
httpProxy	string http proxy for executor containers
httpsProxy	string https proxy for executor containers
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 for container executors with test artifacts
jobTemplate	string job template extensions

Responses

Request samples

Payload

Content type

application/json

{"name": "testing with 1000 users",
"testSuiteName": "test-suite1",
"number": 0,
"executionLabels": {"users": "3",
"prefix": "some-"
},
"namespace": "testkube",
"variablesFile": "string",
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"command": ["curl"
],
"args": ["--repeats",
"5",
"--insecure"
],
"image": "kubeshop/testkube-executor-custom:1.10.11-dev-0a9c91",
"imagePullSecrets": [{"name": "string"
}
],
"envs": {"record": "true",
"prefix": "some-"
},
"secretEnvs": {"secret_key_name1": "secret-name",
"secret_Key_name2": "secret-name"
},
"sync": true,
"httpProxy": "user:pass@my.proxy.server:8080",
"httpsProxy": "user:pass@my.proxy.server:8081",
"activeDeadlineSeconds": 1,
"uploads": ["settings/config.txt"
],
"bucketName": "execution-c01d7cf6-ec3f-47f0-9556-a5d6e9009a43",
"artifactRequest": {"storageClassName": "artifact-volume-local",
"volumeMountPath": "string",
"dirs": ["string"
]
},
"jobTemplate": "string"
}

Response samples

201
400
500
502

Content type

application/json

{"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 all test executions

Returns array of all available test executions

path Parameters

id

required

string

unique id of the object

query Parameters

last	integer Default: 7 last N days to show
pageSize	integer Default: 100 the number of executions to get, setting to 0 will return only totals
page	integer Default: 0 the page index to start at
status	string (ExecutionStatus) Enum: "queued" "running" "passed" "failed" "aborted" "timeout" 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

Responses

Response samples

200
500

Content type

application/json

{"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": {"env": "prod",
"app": "backend"
}
}
]
}

Get test execution

Returns execution with given executionID

path Parameters

id required	string unique id of the object
executionID required	string unique id of the object execution

Responses

Response samples

200
500

Content type

application/json

{"id": "62f395e004109209b50edfc4",
"testName": "example-test",
"testSuiteName": "test-suite1",
"testNamespace": "testkube",
"testType": "postman/collection",
"name": "test-suite1-example-test-1",
"number": 1,
"envs": {"record": "true",
"prefix": "some-"
},
"args": ["--concurrency",
"2",
"--remote",
"--some",
"blabla"
],
"variables": {"var1": {"name": "var1",
"type": "basic",
"value": "value1"
},
"secret1": {"name": "secret1",
"type": "secret",
"value": "secretvalue1"
}
},
"variablesFile": "string",
"testSecretUUID": "7934600f-b367-48dd-b981-4353304362fb",
"testSuiteSecre