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

Testkube Control Plane ../templates operations

Testkube Pro API (cloud-api/1.10.38)

Download OpenAPI specification:Download

API for Testkube Pro

List templates

List templates 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 template

Create new template based on variables passed in request

path Parameters
id
required
string

organizationId

environmentId
required
string

environmentID

Request Body schema:
required

template request body data

name
required
string

template name for reference

namespace
string

template namespace

type
required
string (TemplateType)
Enum: "job" "container" "cronjob" "scraper" "pvc" "webhook" "pod"

template type by purpose

body
required
string

template body to use

object

template labels

Responses

Request samples

Content type
{
  • "name": "webhook-template",
  • "namespace": "testkube",
  • "type": "job",
  • "body": "{\"id\": \"{{ .Id }}\"}",
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "name": "webhook-template",
  • "namespace": "testkube",
  • "type": "job",
  • "body": "{\"id\": \"{{ .Id }}\"}",
  • "labels": {
    }
}

Delete templates

Deletes labeled templates

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 template details

Returns template

path Parameters
environmentId
required
string

environmentID

id
required
string

unique id of the object

Responses

Response samples

Content type
{
  • "name": "webhook-template",
  • "namespace": "testkube",
  • "type": "job",
  • "body": "{\"id\": \"{{ .Id }}\"}",
  • "labels": {
    }
}

Delete template

Deletes template 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 new template

Update new template based on variables passed in request

path Parameters
environmentId
required
string

environmentID

id
required
string

unique id of the object

Request Body schema:
required

template request body data

name
required
string

template name for reference

namespace
string

template namespace

type
required
string (TemplateType)
Enum: "job" "container" "cronjob" "scraper" "pvc" "webhook" "pod"

template type by purpose

body
required
string

template body to use

object

template labels

Responses

Request samples

Content type
{
  • "name": "webhook-template",
  • "namespace": "testkube",
  • "type": "job",
  • "body": "{\"id\": \"{{ .Id }}\"}",
  • "labels": {
    }
}

Response samples

Content type
application/json
{
  • "name": "webhook-template",
  • "namespace": "testkube",
  • "type": "job",
  • "body": "{\"id\": \"{{ .Id }}\"}",
  • "labels": {
    }
}