Testkube Control Plane ../templates operations

• getList templates
• postCreate new template
• delDelete templates
• getGet template details
• delDelete template
• patchUpdate new template

API docs by Redocly

Testkube Pro API (cloud-api/1.10.51)

Download OpenAPI specification:Download

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

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

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentId}/agent/templates

Response samples

• 200
• 400
• 502

Content type

application/jsontext/yamlapplication/json

[

• {

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

    • "app": "backend",
    • "env": "prod"

    }

  }

]

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:

application/jsontext/yamlapplication/json

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

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentId}/agent/templates

Request samples

• Payload

Content type

application/jsontext/yamlapplication/json

{

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

  • "app": "backend",
  • "env": "prod"

  }

}

Response samples

• 201
• 400
• 502

Content type

application/json

{

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

  • "app": "backend",
  • "env": "prod"

  }

}

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

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentId}/agent/templates

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

Returns template

path Parameters

environmentId required	string environmentID
id required	string unique id of the object

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentId}/agent/templates/{id}

Response samples

• 200
• 400
• 404
• 500
• 502

Content type

application/jsontext/yamlapplication/json

{

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

  • "app": "backend",
  • "env": "prod"

  }

}

Delete template

Deletes template by its name

path Parameters

environmentId required	string environmentID
id required	string unique id of the object

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentId}/agent/templates/{id}

Response samples

• 404
• 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 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:

application/jsontext/yamlapplication/json

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

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentId}/agent/templates/{id}

Request samples

• Payload

Content type

application/jsontext/yamlapplication/json

{

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

  • "app": "backend",
  • "env": "prod"

  }

}

Response samples

• 200
• 400
• 404
• 502

Content type

application/json

{

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

  • "app": "backend",
  • "env": "prod"

  }

}