KillSwitches

Create a kill switch

Changed on

Superadmin-only. Creates a kill switch.

post/api/v1/kill-switches

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/kill-switches
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Request body

idstring
namestring required
tenantIdstring
namespacestring
flowIdstring
executionIdsstring[]
startDatestring date-time required
endDatestring date-time
descriptionstring
evaluationType'PASS' | 'KILL' | 'CANCEL' | 'IGNORE' required
enabledboolean
deletedboolean

Example request

{
  "evaluationType": "PASS",
  "executionIds": [
    "executionIds",
    "executionIds"
  ],
  "deleted": true,
  "endDate": "2000-01-23T04:56:07.000+00:00",
  "name": "name",
  "tenantId": "tenantId",
  "namespace": "namespace",
  "description": "description",
  "id": "id",
  "flowId": "flowId",
  "startDate": "2000-01-23T04:56:07.000+00:00",
  "enabled": true
}

Response

createKillSwitch 200 response

idstring
namestring required
tenantIdstring
namespacestring
flowIdstring
executionIdsstring[]
startDatestring date-time required
endDatestring date-time
descriptionstring
evaluationType'PASS' | 'KILL' | 'CANCEL' | 'IGNORE' required
enabledboolean
deletedboolean

Example response

{
  "evaluationType": "PASS",
  "executionIds": [
    "executionIds",
    "executionIds"
  ],
  "deleted": true,
  "endDate": "2000-01-23T04:56:07.000+00:00",
  "name": "name",
  "tenantId": "tenantId",
  "namespace": "namespace",
  "description": "description",
  "id": "id",
  "flowId": "flowId",
  "startDate": "2000-01-23T04:56:07.000+00:00",
  "enabled": true
}

Changes