Testkube Agent /triggers operations

• getList test triggers
• postCreate new test trigger
• patchBulk update test triggers
• delDelete test triggers
• getGet test trigger by ID
• patchUpdate test trigger
• delDelete test trigger

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 triggers

List test triggers from the kubernetes cluster

query Parameters

namespace	string Default: "testkube" Namespace of the object
selector	string Labels to filter by

Responses

Testkube Cloud API Endpoint

https://api.testkube.io/triggers

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/triggers

Response samples

• 200
• 400
• 502

Content type

application/jsontext/yamlapplication/json

[

• {

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

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

    },
  • "annotations": {

    • "group": "teamA",
    • "app": "backend"

    },
  • "resource": "pod",
  • "resourceSelector": {

    • "name": "nginx",
    • "nameRegex": "nginx.*",
    • "namespace": "testkube",
    • "labelSelector": {

      • "matchExpressions": [

        • {

          • "key": "string",
          • "operator": "string",
          • "values": [

            • "string"

            ]

          }

        ],
      • "matchLabels": {

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

        }

      }

    },
  • "event": "modified",
  • "conditionSpec": {

    • "conditions": [

      • {

        • "status": "True",
        • "type": "Progressing",
        • "reason": "NewReplicaSetAvailable",
        • "ttl": 1

        }

      ],
    • "timeout": 1,
    • "delay": 1

    },
  • "probeSpec": {

    • "probes": [

      • {

        • "scheme": "http",
        • "host": "testkube-api-server",
        • "path": "/",
        • "port": 80,
        • "headers": {

          • "Content-Type": "application/xml"

          }

        }

      ],
    • "timeout": 1,
    • "delay": 1

    },
  • "action": "run",
  • "execution": "test",
  • "testSelector": {

    • "name": "nginx",
    • "nameRegex": "nginx.*",
    • "namespace": "testkube",
    • "labelSelector": {

      • "matchExpressions": [

        • {

          • "key": "string",
          • "operator": "string",
          • "values": [

            • "string"

            ]

          }

        ],
      • "matchLabels": {

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

        }

      }

    },
  • "concurrencyPolicy": "allow",
  • "disabled": [

    • true,
    • false

    ]

  }

]

Create new test trigger

Create new test trigger CRD inside a Kubernetes cluster

Request Body schema:

application/jsontext/yamlapplication/json

required

test trigger body

name required	string test trigger name
namespace	string test trigger namespace
	object test trigger labels
	object test trigger annotations
resource required	string (TestTriggerResources) Enum: "pod" "deployment" "statefulset" "daemonset" "service" "ingress" "event" "configmap" supported kubernetes resources for test triggers
required	object (TestTriggerSelector)
event required	string listen for event for selected resource
	object (TestTriggerConditionSpec)
	object (TestTriggerProbeSpec)
action required	string (TestTriggerActions) Value: "run" supported actions for test triggers
execution required	string (TestTriggerExecutions) Enum: "test" "testsuite" "testworkflow" supported test resources for test triggers
required	object (TestTriggerSelector)
concurrencyPolicy	string (TestTriggerConcurrencyPolicies) Enum: "allow" "forbid" "replace" supported concurrency policies for test triggers
disabled	boolean Default: false whether test trigger is disabled

Responses

Testkube Cloud API Endpoint

https://api.testkube.io/triggers

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/triggers

Request samples

• Payload

Content type

application/jsontext/yamlapplication/json

{

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

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

  },
• "annotations": {

  • "group": "teamA",
  • "app": "backend"

  },
• "resource": "pod",
• "resourceSelector": {

  • "name": "nginx",
  • "nameRegex": "nginx.*",
  • "namespace": "testkube",
  • "labelSelector": {

    • "matchExpressions": [

      • {

        • "key": "string",
        • "operator": "string",
        • "values": [

          • "string"

          ]

        }

      ],
    • "matchLabels": {

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

      }

    }

  },
• "event": "modified",
• "conditionSpec": {

  • "conditions": [

    • {

      • "status": "True",
      • "type": "Progressing",
      • "reason": "NewReplicaSetAvailable",
      • "ttl": 1

      }

    ],
  • "timeout": 1,
  • "delay": 1

  },
• "probeSpec": {

  • "probes": [

    • {

      • "scheme": "http",
      • "host": "testkube-api-server",
      • "path": "/",
      • "port": 80,
      • "headers": {

        • "Content-Type": "application/xml"

        }

      }

    ],
  • "timeout": 1,
  • "delay": 1

  },
• "action": "run",
• "execution": "test",
• "testSelector": {

  • "name": "nginx",
  • "nameRegex": "nginx.*",
  • "namespace": "testkube",
  • "labelSelector": {

    • "matchExpressions": [

      • {

        • "key": "string",
        • "operator": "string",
        • "values": [

          • "string"

          ]

        }

      ],
    • "matchLabels": {

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

      }

    }

  },
• "concurrencyPolicy": "allow",
• "disabled": [

  • true,
  • false

  ]

}

Response samples

• 200
• 400
• 502

Content type

application/jsontext/yamlapplication/json

{

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

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

  },
• "annotations": {

  • "group": "teamA",
  • "app": "backend"

  },
• "resource": "pod",
• "resourceSelector": {

  • "name": "nginx",
  • "nameRegex": "nginx.*",
  • "namespace": "testkube",
  • "labelSelector": {

    • "matchExpressions": [

      • {

        • "key": "string",
        • "operator": "string",
        • "values": [

          • "string"

          ]

        }

      ],
    • "matchLabels": {

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

      }

    }

  },
• "event": "modified",
• "conditionSpec": {

  • "conditions": [

    • {

      • "status": "True",
      • "type": "Progressing",
      • "reason": "NewReplicaSetAvailable",
      • "ttl": 1

      }

    ],
  • "timeout": 1,
  • "delay": 1

  },
• "probeSpec": {

  • "probes": [

    • {

      • "scheme": "http",
      • "host": "testkube-api-server",
      • "path": "/",
      • "port": 80,
      • "headers": {

        • "Content-Type": "application/xml"

        }

      }

    ],
  • "timeout": 1,
  • "delay": 1

  },
• "action": "run",
• "execution": "test",
• "testSelector": {

  • "name": "nginx",
  • "nameRegex": "nginx.*",
  • "namespace": "testkube",
  • "labelSelector": {

    • "matchExpressions": [

      • {

        • "key": "string",
        • "operator": "string",
        • "values": [

          • "string"

          ]

        }

      ],
    • "matchLabels": {

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

      }

    }

  },
• "concurrencyPolicy": "allow",
• "disabled": [

  • true,
  • false

  ]

}

Bulk update test triggers

Updates test triggers provided as an array in the request body

Request Body schema: application/json

required

array of test trigger upsert requests

Array

name required	string test trigger name
namespace	string test trigger namespace
	object test trigger labels
	object test trigger annotations
resource required	string (TestTriggerResources) Enum: "pod" "deployment" "statefulset" "daemonset" "service" "ingress" "event" "configmap" supported kubernetes resources for test triggers
required	object (TestTriggerSelector)
event required	string listen for event for selected resource
	object (TestTriggerConditionSpec)
	object (TestTriggerProbeSpec)
action required	string (TestTriggerActions) Value: "run" supported actions for test triggers
execution required	string (TestTriggerExecutions) Enum: "test" "testsuite" "testworkflow" supported test resources for test triggers
required	object (TestTriggerSelector)
concurrencyPolicy	string (TestTriggerConcurrencyPolicies) Enum: "allow" "forbid" "replace" supported concurrency policies for test triggers
disabled	boolean Default: false whether test trigger is disabled

Responses

Testkube Cloud API Endpoint

https://api.testkube.io/triggers

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/triggers

Request samples

• Payload

Content type

application/json

[

• {

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

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

    },
  • "annotations": {

    • "group": "teamA",
    • "app": "backend"

    },
  • "resource": "pod",
  • "resourceSelector": {

    • "name": "nginx",
    • "nameRegex": "nginx.*",
    • "namespace": "testkube",
    • "labelSelector": {

      • "matchExpressions": [

        • {

          • "key": "string",
          • "operator": "string",
          • "values": [

            • "string"

            ]

          }

        ],
      • "matchLabels": {

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

        }

      }

    },
  • "event": "modified",
  • "conditionSpec": {

    • "conditions": [

      • {

        • "status": "True",
        • "type": "Progressing",
        • "reason": "NewReplicaSetAvailable",
        • "ttl": 1

        }

      ],
    • "timeout": 1,
    • "delay": 1

    },
  • "probeSpec": {

    • "probes": [

      • {

        • "scheme": "http",
        • "host": "testkube-api-server",
        • "path": "/",
        • "port": 80,
        • "headers": {

          • "Content-Type": "application/xml"

          }

        }

      ],
    • "timeout": 1,
    • "delay": 1

    },
  • "action": "run",
  • "execution": "test",
  • "testSelector": {

    • "name": "nginx",
    • "nameRegex": "nginx.*",
    • "namespace": "testkube",
    • "labelSelector": {

      • "matchExpressions": [

        • {

          • "key": "string",
          • "operator": "string",
          • "values": [

            • "string"

            ]

          }

        ],
      • "matchLabels": {

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

        }

      }

    },
  • "concurrencyPolicy": "allow",
  • "disabled": [

    • true,
    • false

    ]

  }

]

Response samples

• 200
• 400
• 502

Content type

application/json

[

• {

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

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

    },
  • "annotations": {

    • "group": "teamA",
    • "app": "backend"

    },
  • "resource": "pod",
  • "resourceSelector": {

    • "name": "nginx",
    • "nameRegex": "nginx.*",
    • "namespace": "testkube",
    • "labelSelector": {

      • "matchExpressions": [

        • {

          • "key": "string",
          • "operator": "string",
          • "values": [

            • "string"

            ]

          }

        ],
      • "matchLabels": {

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

        }

      }

    },
  • "event": "modified",
  • "conditionSpec": {

    • "conditions": [

      • {

        • "status": "True",
        • "type": "Progressing",
        • "reason": "NewReplicaSetAvailable",
        • "ttl": 1

        }

      ],
    • "timeout": 1,
    • "delay": 1

    },
  • "probeSpec": {

    • "probes": [

      • {

        • "scheme": "http",
        • "host": "testkube-api-server",
        • "path": "/",
        • "port": 80,
        • "headers": {

          • "Content-Type": "application/xml"

          }

        }

      ],
    • "timeout": 1,
    • "delay": 1

    },
  • "action": "run",
  • "execution": "test",
  • "testSelector": {

    • "name": "nginx",
    • "nameRegex": "nginx.*",
    • "namespace": "testkube",
    • "labelSelector": {

      • "matchExpressions": [

        • {

          • "key": "string",
          • "operator": "string",
          • "values": [

            • "string"

            ]

          }

        ],
      • "matchLabels": {

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

        }

      }

    },
  • "concurrencyPolicy": "allow",
  • "disabled": [

    • true,
    • false

    ]

  }

]

Delete test triggers

Deletes all or labeled test triggers

query Parameters

namespace	string Default: "testkube" Namespace of the object
selector	string Labels to filter by

Responses

Testkube Cloud API Endpoint

https://api.testkube.io/triggers

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/triggers

Response samples

• 400
• 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"

  }

]

Get test trigger by ID

Get test trigger by ID from CRD in kubernetes cluster

path Parameters

id required

string unique id of the object

query Parameters

namespace

string Default: "testkube" Namespace of the object

Responses

Testkube Cloud API Endpoint

https://api.testkube.io/triggers/{id}

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/triggers/{id}

Response samples

• 200
• 404
• 502

Content type

application/jsontext/yamlapplication/json

{

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

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

  },
• "annotations": {

  • "group": "teamA",
  • "app": "backend"

  },
• "resource": "pod",
• "resourceSelector": {

  • "name": "nginx",
  • "nameRegex": "nginx.*",
  • "namespace": "testkube",
  • "labelSelector": {

    • "matchExpressions": [

      • {

        • "key": "string",
        • "operator": "string",
        • "values": [

          • "string"

          ]

        }

      ],
    • "matchLabels": {

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

      }

    }

  },
• "event": "modified",
• "conditionSpec": {

  • "conditions": [

    • {

      • "status": "True",
      • "type": "Progressing",
      • "reason": "NewReplicaSetAvailable",
      • "ttl": 1

      }

    ],
  • "timeout": 1,
  • "delay": 1

  },
• "probeSpec": {

  • "probes": [

    • {

      • "scheme": "http",
      • "host": "testkube-api-server",
      • "path": "/",
      • "port": 80,
      • "headers": {

        • "Content-Type": "application/xml"

        }

      }

    ],
  • "timeout": 1,
  • "delay": 1

  },
• "action": "run",
• "execution": "test",
• "testSelector": {

  • "name": "nginx",
  • "nameRegex": "nginx.*",
  • "namespace": "testkube",
  • "labelSelector": {

    • "matchExpressions": [

      • {

        • "key": "string",
        • "operator": "string",
        • "values": [

          • "string"

          ]

        }

      ],
    • "matchLabels": {

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

      }

    }

  },
• "concurrencyPolicy": "allow",
• "disabled": [

  • true,
  • false

  ]

}

Update test trigger

Update test trigger

path Parameters

id required

string unique id of the object

query Parameters

namespace

string Default: "testkube" Namespace of the object

Request Body schema:

application/jsontext/yamlapplication/json

required

test trigger upsert request

name required	string test trigger name
namespace	string test trigger namespace
	object test trigger labels
	object test trigger annotations
resource required	string (TestTriggerResources) Enum: "pod" "deployment" "statefulset" "daemonset" "service" "ingress" "event" "configmap" supported kubernetes resources for test triggers
required	object (TestTriggerSelector)
event required	string listen for event for selected resource
	object (TestTriggerConditionSpec)
	object (TestTriggerProbeSpec)
action required	string (TestTriggerActions) Value: "run" supported actions for test triggers
execution required	string (TestTriggerExecutions) Enum: "test" "testsuite" "testworkflow" supported test resources for test triggers
required	object (TestTriggerSelector)
concurrencyPolicy	string (TestTriggerConcurrencyPolicies) Enum: "allow" "forbid" "replace" supported concurrency policies for test triggers
disabled	boolean Default: false whether test trigger is disabled

Responses

Testkube Cloud API Endpoint

https://api.testkube.io/triggers/{id}

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/triggers/{id}

Request samples

• Payload

Content type

application/jsontext/yamlapplication/json

{

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

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

  },
• "annotations": {

  • "group": "teamA",
  • "app": "backend"

  },
• "resource": "pod",
• "resourceSelector": {

  • "name": "nginx",
  • "nameRegex": "nginx.*",
  • "namespace": "testkube",
  • "labelSelector": {

    • "matchExpressions": [

      • {

        • "key": "string",
        • "operator": "string",
        • "values": [

          • "string"

          ]

        }

      ],
    • "matchLabels": {

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

      }

    }

  },
• "event": "modified",
• "conditionSpec": {

  • "conditions": [

    • {

      • "status": "True",
      • "type": "Progressing",
      • "reason": "NewReplicaSetAvailable",
      • "ttl": 1

      }

    ],
  • "timeout": 1,
  • "delay": 1

  },
• "probeSpec": {

  • "probes": [

    • {

      • "scheme": "http",
      • "host": "testkube-api-server",
      • "path": "/",
      • "port": 80,
      • "headers": {

        • "Content-Type": "application/xml"

        }

      }

    ],
  • "timeout": 1,
  • "delay": 1

  },
• "action": "run",
• "execution": "test",
• "testSelector": {

  • "name": "nginx",
  • "nameRegex": "nginx.*",
  • "namespace": "testkube",
  • "labelSelector": {

    • "matchExpressions": [

      • {

        • "key": "string",
        • "operator": "string",
        • "values": [

          • "string"

          ]

        }

      ],
    • "matchLabels": {

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

      }

    }

  },
• "concurrencyPolicy": "allow",
• "disabled": [

  • true,
  • false

  ]

}

Response samples

• 200
• 400
• 404
• 502

Content type

application/json

{

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

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

  },
• "annotations": {

  • "group": "teamA",
  • "app": "backend"

  },
• "resource": "pod",
• "resourceSelector": {

  • "name": "nginx",
  • "nameRegex": "nginx.*",
  • "namespace": "testkube",
  • "labelSelector": {

    • "matchExpressions": [

      • {

        • "key": "string",
        • "operator": "string",
        • "values": [

          • "string"

          ]

        }

      ],
    • "matchLabels": {

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

      }

    }

  },
• "event": "modified",
• "conditionSpec": {

  • "conditions": [

    • {

      • "status": "True",
      • "type": "Progressing",
      • "reason": "NewReplicaSetAvailable",
      • "ttl": 1

      }

    ],
  • "timeout": 1,
  • "delay": 1

  },
• "probeSpec": {

  • "probes": [

    • {

      • "scheme": "http",
      • "host": "testkube-api-server",
      • "path": "/",
      • "port": 80,
      • "headers": {

        • "Content-Type": "application/xml"

        }

      }

    ],
  • "timeout": 1,
  • "delay": 1

  },
• "action": "run",
• "execution": "test",
• "testSelector": {

  • "name": "nginx",
  • "nameRegex": "nginx.*",
  • "namespace": "testkube",
  • "labelSelector": {

    • "matchExpressions": [

      • {

        • "key": "string",
        • "operator": "string",
        • "values": [

          • "string"

          ]

        }

      ],
    • "matchLabels": {

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

      }

    }

  },
• "concurrencyPolicy": "allow",
• "disabled": [

  • true,
  • false

  ]

}

Delete test trigger

Deletes a test trigger

path Parameters

id required

string unique id of the object

query Parameters

namespace

string Default: "testkube" Namespace of the object

Responses

Testkube Cloud API Endpoint

https://api.testkube.io/triggers/{id}

Testkube On-Prem API Endpoint

https://<your-testkube-api-host>/triggers/{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"

  }

]