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

Request

  • Base URL
    https://api.cloudranger.com/202004
  • URL
    https://api.cloudranger.com/202004/organizations/{organization_id}/tasks/{task_id}/stop
  • Auth
    API key in header Authorization and API key in header x-api-key

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

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

Response

200 response

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

Changes

No recorded changes to this operation across all 1 revision of this API.