Skip to main content
New to Testkube? Unleash the power of cloud native testing in Kubernetes with Testkube. Get Started >

Testkube Agent /test-suite-executions operations

API docs by Redocly

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

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
required

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

object (TestContentRequest)

test content request body

object (RunningContext)

running context for test or test suite execution

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

scraperTemplate
string

scraper template extensions

scraperTemplateReference
string

name of the template resource

pvcTemplate
string

pvc template extensions

pvcTemplateReference
string

name of the template resource

concurrencyLevel
integer <int32>

number of tests run in parallel

testSuiteExecutionName
string

test suite execution name started the test suite execution

disableWebhooks
boolean
Default: false

whether webhooks on the execution of this test suite are disabled

Responses

Request samples

Content type
application/json
{
  • "name": "testing with 1000 users",
  • "number": 1,
  • "namespace": "testkube",
  • "variables": {
    },
  • "labels": {
    },
  • "executionLabels": {
    },
  • "sync": true,
  • "httpProxy": "user:pass@my.proxy.server:8080",
  • "httpsProxy": "user:pass@my.proxy.server:8081",
  • "timeout": 1,
  • "contentRequest": {
    },
  • "runningContext": {
    },
  • "jobTemplate": "string",
  • "jobTemplateReference": "string",
  • "cronJobTemplate": "string",
  • "cronJobTemplateReference": "string",
  • "scraperTemplate": "string",
  • "scraperTemplateReference": "string",
  • "pvcTemplate": "string",
  • "pvcTemplateReference": "string",
  • "concurrencyLevel": 10,
  • "testSuiteExecutionName": "string",
  • "disableWebhooks": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "totals": {
    },
  • "filtered": {
    },
  • "results": [
    ]
}

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

Content type
application/json
{
  • "id": "62f395e004109209b50edfc1",
  • "name": "test-suite1.needlessly-sweet-imp",
  • "testSuite": {
    },
  • "status": "queued",
  • "envs": {
    },
  • "variables": {
    },
  • "secretUUID": "7934600f-b367-48dd-b981-4353304362fb",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "duration": "2m",
  • "durationMs": 6000,
  • "stepResults": [
    ],
  • "executeStepResults": [
    ],
  • "labels": {
    },
  • "runningContext": {
    },
  • "testSuiteExecutionName": "string",
  • "disableWebhooks": [
    ]
}

Aborts testsuite execution

Aborts testsuite execution with given executionID

path Parameters
executionID
required
string

unique id of the object execution

Responses

Response samples

Content type
application/problem+json
[]

Get test suite execution artifacts

Returns test suite execution artifacts with given executionID

path Parameters
executionID
required
string

unique id of the object execution

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "size": 0,
  • "executionName": "test-1",
  • "status": "ready"
}