SCscaleapi
Tasks

Terminate Task

Changed on

Mark a running task as terminated.

post/tasks/{task_id}/terminate

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

task_idstring required

Request body

reasonstring nullable

Response

Successful Response

idstring required
namestring nullable
status'CANCELED' | 'COMPLETED' | 'FAILED' | 'RUNNING' | 'INTERRUPTED' | 'TERMINATED' | 'TIMED_OUT' | 'DELETED'
status_reasonstring nullable
created_atstring date-time nullable
updated_atstring date-time nullable
cleaned_atstring date-time nullable
paramsobject nullable
task_metadataobject nullable

Changes

  • 702bb2729fe2Revision changes
    • warning

      added the new INTERRUPTED enum value to the / response property for the response status

  • 12a516f4d9acRevision changes
    • info

      added the optional property to the response with the status