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

Testkube Control Plane ../executors operations

Testkube Pro API (cloud-api/1.10.51)

Download OpenAPI specification:Download

API for Testkube Pro

List executors

List executors available in cluster

path Parameters
id
required
string

organizationId

environmentId
required
string

environmentID

query Parameters
selector
string
Example: selector=kubernetes.io/app=demo

Only workflow executions with given status are included in this time series chart.

Responses

Response samples

Content type
[
  • {
    }
]

Create new executor

Create new executor based on variables passed in request

path Parameters
id
required
string

organizationId

environmentId
required
string

environmentID

Request Body schema:
required

executor request body data

executorType
string

ExecutorType one of "rest" for rest openapi based executors or "job" which will be default runners for testkube soon

image
string

Image for kube-job

object (SlavesMeta)

Slave data for executing tests in distributed environment

Array of objects (LocalObjectReference)

container image pull secrets

command
Array of strings

executor image command

args
Array of strings

additional executor binary argument

types
required
Array of strings

Types defines what types can be handled by executor e.g. "postman/collection", ":curl/command" etc

uri
string

URI for rest based executors

contentTypes
Array of strings

list of handled content types

jobTemplate
string

Job template to launch executor

jobTemplateReference
string

name of the template resource

object

executor labels

features
Array of strings
Items Enum: "artifacts" "junit-report"

Available executor features

object (ExecutorMeta)

Executor meta data

useDataDirAsWorkingDir
boolean

use data dir as working dir for executor

namespace
required
string

object kubernetes namespace

name
required
string

object name

Responses

Request samples

Content type
{
  • "executorType": "string",
  • "image": "string",
  • "slaves": {
    },
  • "imagePullSecrets": [
    ],
  • "command": [
    ],
  • "args": [
    ],
  • "types": [
    ],
  • "uri": "string",
  • "contentTypes": [
    ],
  • "jobTemplate": "string",
  • "jobTemplateReference": "string",
  • "labels": {
    },
  • "features": [
    ],
  • "meta": {},
  • "useDataDirAsWorkingDir": true,
  • "namespace": "testkube",
  • "name": "name"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "executor": {
    },
  • "executions": {
    }
}

Delete executors

Deletes labeled executors

path Parameters
id
required
string

organizationId

environmentId
required
string

environmentID

query Parameters
selector
string
Example: selector=kubernetes.io/app=demo

Only workflow executions with given status are included in this time series chart.

Responses

Response samples

Content type
application/problem+json
[]

Get executor details

Returns executors data with executions passed to executor

path Parameters
environmentId
required
string

environmentID

id
required
string

unique id of the object

Responses

Response samples

Content type
{
  • "name": "string",
  • "executor": {
    },
  • "executions": {
    }
}

Delete executor

Deletes executor by its name

path Parameters
environmentId
required
string

environmentID

id
required
string

unique id of the object

Responses

Response samples

Content type
application/problem+json
[]

Update executor

Update new executor based on variables passed in request

path Parameters
environmentId
required
string

environmentID

id
required
string

unique id of the object

Request Body schema:
required

executor request body data

executorType
string

ExecutorType one of "rest" for rest openapi based executors or "job" which will be default runners for testkube soon

image
string

Image for kube-job

object (SlavesMeta)

Slave data for executing tests in distributed environment

Array of objects (LocalObjectReference)

container image pull secrets

command
Array of strings

executor image command

args
Array of strings

additional executor binary argument

types
Array of strings

Types defines what types can be handled by executor e.g. "postman/collection", ":curl/command" etc

uri
string

URI for rest based executors

contentTypes
Array of strings

list of handled content types

jobTemplate
string

Job template to launch executor

jobTemplateReference
string

name of the template resource

object

executor labels

features
Array of strings
Items Enum: "artifacts" "junit-report"

Available executor features

object (ExecutorMeta)

Executor meta data

useDataDirAsWorkingDir
boolean

use data dir as working dir for executor

namespace
string

object kubernetes namespace

name
required
string

object name

Responses

Request samples

Content type
{
  • "executorType": "string",
  • "image": "string",
  • "slaves": {
    },
  • "imagePullSecrets": [
    ],
  • "command": [
    ],
  • "args": [
    ],
  • "types": [
    ],
  • "uri": "string",
  • "contentTypes": [
    ],
  • "jobTemplate": "string",
  • "jobTemplateReference": "string",
  • "labels": {
    },
  • "features": [
    ],
  • "meta": {},
  • "useDataDirAsWorkingDir": true,
  • "namespace": "testkube",
  • "name": "name"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "executor": {
    },
  • "executions": {
    }
}