Cancel a trigger

Cancel a trigger by sending a DELETE request to /cancel with either ttr-trigger-idheader or ttr-custom-keyheader.

The same endpoint cancels both one-shot triggers and recurring triggers (cron generators). The lookup tries generators first, then falls back to one-shot triggers — which is unambiguous because the custom-key namespace is shared (see Custom trigger keys).

Request headers

HeaderRequiredDescription
ttr-api-keyheaderYesYour API key
ttr-trigger-idheaderOne of theseThe trigger or generator ID to cancel
ttr-custom-keyheaderOne of theseThe custom key of the trigger or generator to cancel

Provide exactly one of ttr-trigger-idheader or ttr-custom-keyheader, not both.

Cancelling a recurring trigger

Cancelling a generator stops it from producing future instances. The currently-pending instance (the next scheduled run) is also cancelled in the same operation. Past instances — whether already executed, running, or completed — are kept untouched.

Status codes

Status codeMeaning
204No ContentTrigger cancelled successfully
400Bad RequestBad request (missing or conflicting identifiers)
401UnauthorizedInvalid API key
404Not FoundTrigger not found
410GoneTrigger already executed or cancelled

TimeTriggers — Schedule HTTP requests at any time.