Testkube Control Plane ../test-sources operations

• getList test sources
• postCreate new test source
• delDelete test sources
• patchProcess test source batch (create, update, delete)
• getGet test source data
• delDelete test source
• patchUpdate test source

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 test sources

List test sources 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/test-sources

Response samples

• 200
• 400
• 502

Content type

application/jsontext/yamlapplication/json

[

• {

  • "name": "testsource1",
  • "namespace": "testkube",
  • "labels": {

    • "property1": "string",
    • "property2": "string"

    },
  • "type": "string",
  • "repository": {

    • "type": "git",
    • "uri": "https://github.com/kubeshop/testkube",
    • "branch": "main",
    • "commit": "b928cbb7186944ab9275937ec1ac3d3738ca2e1d",
    • "path": "test/perf",
    • "username": "string",
    • "token": "string",
    • "usernameSecret": {

      • "namespace": "string",
      • "name": "string",
      • "key": "string"

      },
    • "tokenSecret": {

      • "namespace": "string",
      • "name": "string",
      • "key": "string"

      },
    • "certificateSecret": "string",
    • "workingDir": "/",
    • "authType": "basic"

    },
  • "data": "string",
  • "uri": "https://github.com/kubeshop/testkube"

  }

]

Create new test source

Create new test source based on variables passed in request

path Parameters

id required	string organizationId
environmentId required	string environmentID

Request Body schema:

application/jsontext/yamlapplication/json

required

test source request body data

name	string test source name
namespace	string test source namespace
	object test source labels
type	string Enum: "string" "file-uri" "git-file" "git-dir" "git" type of sources a runner can get data from. string: String content (e.g. Postman JSON file). file-uri: content stored on the webserver. git-file: the file stored in the Git repo in the given repository.path field (Deprecated: use git instead). git-dir: the entire git repo or git subdirectory depending on the repository.path field (Testkube does a shadow clone and sparse checkout to limit IOs in the case of monorepos). (Deprecated: use git instead). git: automatically provisions either a file, directory or whole git repository depending on the repository.path field.
	object (Repository) repository representation for tests in git repositories
data	string test content data as string
uri	string test content

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentId}/agent/test-sources

Request samples

• Payload

Content type

application/jsontext/yamlapplication/json

{

• "name": "testsource1",
• "namespace": "testkube",
• "labels": {

  • "property1": "string",
  • "property2": "string"

  },
• "type": "string",
• "repository": {

  • "type": "git",
  • "uri": "https://github.com/kubeshop/testkube",
  • "branch": "main",
  • "commit": "b928cbb7186944ab9275937ec1ac3d3738ca2e1d",
  • "path": "test/perf",
  • "username": "string",
  • "token": "string",
  • "usernameSecret": {

    • "namespace": "string",
    • "name": "string",
    • "key": "string"

    },
  • "tokenSecret": {

    • "namespace": "string",
    • "name": "string",
    • "key": "string"

    },
  • "certificateSecret": "string",
  • "workingDir": "/",
  • "authType": "basic"

  },
• "data": "string",
• "uri": "https://github.com/kubeshop/testkube"

}

Response samples

• 201
• 400
• 502

Content type

application/json

{

• "name": "testsource1",
• "namespace": "testkube",
• "labels": {

  • "property1": "string",
  • "property2": "string"

  },
• "type": "string",
• "repository": {

  • "type": "git",
  • "uri": "https://github.com/kubeshop/testkube",
  • "branch": "main",
  • "commit": "b928cbb7186944ab9275937ec1ac3d3738ca2e1d",
  • "path": "test/perf",
  • "username": "string",
  • "token": "string",
  • "usernameSecret": {

    • "namespace": "string",
    • "name": "string",
    • "key": "string"

    },
  • "tokenSecret": {

    • "namespace": "string",
    • "name": "string",
    • "key": "string"

    },
  • "certificateSecret": "string",
  • "workingDir": "/",
  • "authType": "basic"

  },
• "data": "string",
• "uri": "https://github.com/kubeshop/testkube"

}

Delete test sources

Deletes labeled test sources

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/test-sources

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"

  }

]

Process test source batch (create, update, delete)

Process test source batch based on variables passed in request

path Parameters

id required	string organizationId
environmentId required	string environmentID

Request Body schema: application/json

required

test source batch request body data

required

Array of objects (TestSourceUpsertRequest)

Array name string test source name namespace string test source namespace object test source labels type string Enum: "string" "file-uri" "git-file" "git-dir" "git" type of sources a runner can get data from. string: String content (e.g. Postman JSON file). file-uri: content stored on the webserver. git-file: the file stored in the Git repo in the given repository.path field (Deprecated: use git instead). git-dir: the entire git repo or git subdirectory depending on the repository.path field (Testkube does a shadow clone and sparse checkout to limit IOs in the case of monorepos). (Deprecated: use git instead). git: automatically provisions either a file, directory or whole git repository depending on the repository.path field. object (Repository) repository representation for tests in git repositories data string test content data as string uri string test content

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentId}/agent/test-sources

Request samples

• Payload

Content type

application/json

{

• "batch": [

  • {

    • "name": "testsource1",
    • "namespace": "testkube",
    • "labels": {

      • "property1": "string",
      • "property2": "string"

      },
    • "type": "string",
    • "repository": {

      • "type": "git",
      • "uri": "https://github.com/kubeshop/testkube",
      • "branch": "main",
      • "commit": "b928cbb7186944ab9275937ec1ac3d3738ca2e1d",
      • "path": "test/perf",
      • "username": "string",
      • "token": "string",
      • "usernameSecret": {

        • "namespace": "string",
        • "name": "string",
        • "key": "string"

        },
      • "tokenSecret": {

        • "namespace": "string",
        • "name": "string",
        • "key": "string"

        },
      • "certificateSecret": "string",
      • "workingDir": "/",
      • "authType": "basic"

      },
    • "data": "string",
    • "uri": "https://github.com/kubeshop/testkube"

    }

  ]

}

Response samples

• 200
• 400
• 502

Content type

application/json

{

• "created": [

  • "name1",
  • "name2",
  • "name3"

  ],
• "updated": [

  • "name4",
  • "name5",
  • "name6"

  ],
• "deleted": [

  • "name7",
  • "name8",
  • "name9"

  ]

}

Get test source data

Returns test sources data

path Parameters

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

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentId}/agent/test-sources/{id}

Response samples

• 200
• 400
• 404
• 500
• 502

Content type

application/jsontext/yamlapplication/json

{

• "name": "testsource1",
• "namespace": "testkube",
• "labels": {

  • "property1": "string",
  • "property2": "string"

  },
• "type": "string",
• "repository": {

  • "type": "git",
  • "uri": "https://github.com/kubeshop/testkube",
  • "branch": "main",
  • "commit": "b928cbb7186944ab9275937ec1ac3d3738ca2e1d",
  • "path": "test/perf",
  • "username": "string",
  • "token": "string",
  • "usernameSecret": {

    • "namespace": "string",
    • "name": "string",
    • "key": "string"

    },
  • "tokenSecret": {

    • "namespace": "string",
    • "name": "string",
    • "key": "string"

    },
  • "certificateSecret": "string",
  • "workingDir": "/",
  • "authType": "basic"

  },
• "data": "string",
• "uri": "https://github.com/kubeshop/testkube"

}

Delete test source

Deletes test source 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/test-sources/{id}

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"

  }

]

Update test source

Update test source based on test content or git based data

path Parameters

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

Request Body schema:

application/jsontext/yamlapplication/json

required

test source body

name	string test source name
namespace	string test source namespace
	object test source labels
type	string Enum: "string" "file-uri" "git-file" "git-dir" "git" type of sources a runner can get data from. string: String content (e.g. Postman JSON file). file-uri: content stored on the webserver. git-file: the file stored in the Git repo in the given repository.path field (Deprecated: use git instead). git-dir: the entire git repo or git subdirectory depending on the repository.path field (Testkube does a shadow clone and sparse checkout to limit IOs in the case of monorepos). (Deprecated: use git instead). git: automatically provisions either a file, directory or whole git repository depending on the repository.path field.
	object (Repository) repository representation for tests in git repositories
data	string test content data as string
uri	string test content

Responses

https://raw.githubusercontent.com/organizations/{id}/environments/{environmentId}/agent/test-sources/{id}

Request samples

• Payload

Content type

application/jsontext/yamlapplication/json

{

• "name": "testsource1",
• "namespace": "testkube",
• "labels": {

  • "property1": "string",
  • "property2": "string"

  },
• "type": "string",
• "repository": {

  • "type": "git",
  • "uri": "https://github.com/kubeshop/testkube",
  • "branch": "main",
  • "commit": "b928cbb7186944ab9275937ec1ac3d3738ca2e1d",
  • "path": "test/perf",
  • "username": "string",
  • "token": "string",
  • "usernameSecret": {

    • "namespace": "string",
    • "name": "string",
    • "key": "string"

    },
  • "tokenSecret": {

    • "namespace": "string",
    • "name": "string",
    • "key": "string"

    },
  • "certificateSecret": "string",
  • "workingDir": "/",
  • "authType": "basic"

  },
• "data": "string",
• "uri": "https://github.com/kubeshop/testkube"

}

Response samples

• 200
• 400
• 404
• 502

Content type

application/json

{

• "name": "testsource1",
• "namespace": "testkube",
• "labels": {

  • "property1": "string",
  • "property2": "string"

  },
• "type": "string",
• "repository": {

  • "type": "git",
  • "uri": "https://github.com/kubeshop/testkube",
  • "branch": "main",
  • "commit": "b928cbb7186944ab9275937ec1ac3d3738ca2e1d",
  • "path": "test/perf",
  • "username": "string",
  • "token": "string",
  • "usernameSecret": {

    • "namespace": "string",
    • "name": "string",
    • "key": "string"

    },
  • "tokenSecret": {

    • "namespace": "string",
    • "name": "string",
    • "key": "string"

    },
  • "certificateSecret": "string",
  • "workingDir": "/",
  • "authType": "basic"

  },
• "data": "string",
• "uri": "https://github.com/kubeshop/testkube"

}