POST Tasks({id})/Cancel

Cancel a task. This stops a task from executing, which is similar to an "induced error". Other tasks will be blocked until the task is retried, or the desired state is modified so that the task is no longer needed.

See DesiredState.

Request Information

Parameters

NameDescriptionAdditional information
id

ID of the task to cancel.

Type: String

Response Information

True.

Response type

Boolean

Response body formats

application/json, text/json

Sample:
true