v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Tasks

Stop A Task

Send a stop event to SQS in an attempt to stop the task from executing

post/organizations/{organization_id}/tasks/{task_id}/stop

Path parameters

organization_idstring required

Organization Id of the Organization that you are working with. This can be found by looking at the organization id in the URL of the dashboard. These are randomly generated alphanumber values

task_idstring required

The unique identifier and primary key of the task table. This is also a foreign key for jobs and steps.

Request body

organization_idstring
timezone_locationstring
namestring
descriptionstring
inherit_tagsboolean
schedule_cronstring
is_activeboolean
is_fls_indexedboolean
fls_index_freqstring
created_bystring
created_atstring date-time
updated_atstring date-time
deleted_atstring
tag_withstring[]
encryption_mappingsstring[]

Response

200 response

idstring
job_idstring
regionstring
resource_typestring
resource_idstring
resource_namestring
actionstring
is_successboolean
haltboolean
created_atstring date-time
updated_atstring date-time