v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Sites

Mark Site Task as Cancelled

Mark a site task as cancelled. This can only be done if the task has already gone on longer than its timeout.

post/v1/sites/{id}/tasks/{task_id}/cancel

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888
task_idstring uuid required

ID of this task

Example:01d680d5-de78-4e26-a380-5f7ad2c0877f

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "success": true
  }
}