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

Testkube Agent /test-workflows 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

List test workflows

List test workflows from the kubernetes cluster

query Parameters
selector
string

Labels to filter by

Responses

Response samples

Content type
[
  • {
    }
]

Delete test workflows

Delete test workflows from the kubernetes cluster

query Parameters
selector
string

Labels to filter by

testWorkflowNames
Array of strings

Responses

Response samples

Content type
application/problem+json
[]

Create test workflow

Create test workflow in the kubernetes cluster

Request Body schema:
required

test workflow body

name
string

kubernetes resource name

namespace
string

kubernetes namespace

description
string

human-readable description

object

test workflow labels

object

test workflow annotations

created
string <date-time>
object (TestWorkflowSpec)
readOnly
boolean

if test workflow is offline and cannot be executed

object (TestWorkflowStatusSummary)

test workflow status

Responses

Request samples

Content type
{
  • "name": "string",
  • "namespace": "string",
  • "description": "string",
  • "labels": {
    },
  • "annotations": {
    },
  • "created": "2022-07-30T06:54:15Z",
  • "spec": {
    },
  • "readOnly": true,
  • "status": {
    }
}

Response samples

Content type
[
  • {
    }
]

List test workflow executions

List test workflow executions

path Parameters
id
required
string

unique id of the object

query Parameters
tagSelector
string

Test workflow execution tags

actorName
string

Test workflow running conntext actor name

actorType
string

Test workflow running conntext actor type

Responses

Response samples

Content type
[
  • {
    }
]

Execute test workflow

Execute test workflow in the kubernetes cluster

path Parameters
id
required
string

unique id of the object

query Parameters
testWorkflowExecutionName
string

test workflow execution name stated the test workflow execution

Request Body schema: application/json
required

test workflow execution request

name
string

custom execution name

object (TestWorkflowConfigValue)

configuration values to pass to the template

testWorkflowExecutionName
string

test workflow execution name started the test workflow execution

disableWebhooks
boolean
Default: false

whether webhooks on the execution of this test workflow are disabled

object (TestWorkflowTagValue)

tag values to pass to the test workflow execution

object (TestWorkflowRunningContext)

running context for test workflow execution

parentExecutionIds
Array of strings

parent execution ids

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "config": {
    },
  • "testWorkflowExecutionName": "string",
  • "disableWebhooks": false,
  • "tags": {
    },
  • "runningContext": {
    },
  • "parentExecutionIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

List test workflow execution tags

List test workflow execution tags for all executed test workflows

path Parameters
id
required
string

unique id of the object

Responses

Response samples

Content type
application/json
{
  • "app": [
    ],
  • "env": [
    ],
  • "toDelete": [
    ]
}

Get test workflow metrics

Get metrics of test workflow executions

path Parameters
id
required
string

unique id of the object

Responses

Response samples

Content type
{
  • "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": [
    ]
}

Get test workflow execution

Get test workflow execution details

path Parameters
id
required
string

unique id of the object

executionID
required
string

unique id of the object execution

Responses

Response samples

Content type
{
  • "id": "62f395e004109209b50edfc1",
  • "groupId": "62f395e004109209b50edfc1",
  • "name": "some-workflow-name-1",
  • "namespace": "my-testkube",
  • "number": 0,
  • "scheduledAt": "2019-08-24T14:15:22Z",
  • "statusAt": "2019-08-24T14:15:22Z",
  • "signature": [
    ],
  • "result": {
    },
  • "output": [
    ],
  • "reports": [
    ],
  • "workflow": {
    },
  • "resolvedWorkflow": {
    },
  • "testWorkflowExecutionName": "string",
  • "disableWebhooks": [
    ],
  • "tags": {
    },
  • "runningContext": {
    },
  • "config": {
    }
}

Abort test workflow execution

Abort test workflow execution

path Parameters
id
required
string

unique id of the object

executionID
required
string

unique id of the object execution

Responses

Response samples

Content type
application/problem+json
[]

Abort all test workflow executions

Abort all test workflow executions

path Parameters
id
required
string

unique id of the object

Responses

Response samples

Content type
application/problem+json
[]

Get test workflow details

Get test workflow details from the kubernetes cluster

path Parameters
id
required
string

unique id of the object

Responses

Response samples

Content type
{
  • "name": "string",
  • "namespace": "string",
  • "description": "string",
  • "labels": {
    },
  • "annotations": {
    },
  • "created": "2022-07-30T06:54:15Z",
  • "spec": {
    },
  • "readOnly": true,
  • "status": {
    }
}

Update test workflow details

Update test workflow details in the kubernetes cluster

path Parameters
id
required
string

unique id of the object

Request Body schema:
required

test workflow body

name
string

kubernetes resource name

namespace
string

kubernetes namespace

description
string

human-readable description

object

test workflow labels

object

test workflow annotations

created
string <date-time>
object (TestWorkflowSpec)
readOnly
boolean

if test workflow is offline and cannot be executed

object (TestWorkflowStatusSummary)

test workflow status

Responses

Request samples

Content type
{
  • "name": "string",
  • "namespace": "string",
  • "description": "string",
  • "labels": {
    },
  • "annotations": {
    },
  • "created": "2022-07-30T06:54:15Z",
  • "spec": {
    },
  • "readOnly": true,
  • "status": {
    }
}

Response samples

Content type
{
  • "name": "string",
  • "namespace": "string",
  • "description": "string",
  • "labels": {
    },
  • "annotations": {
    },
  • "created": "2022-07-30T06:54:15Z",
  • "spec": {
    },
  • "readOnly": true,
  • "status": {
    }
}

Delete test workflow

Delete test workflow from the kubernetes cluster

path Parameters
id
required
string

unique id of the object

query Parameters
skipDeleteExecutions
boolean
Default: false

dont delete executions

skipDeleteCRD
boolean
Default: false

dont delete CRD

Responses

Response samples

Content type
application/problem+json
[]