Stop A Task

post https://api.cloudranger.com/202004/organizations/{organization_id}/accounts/{account_id}/tasks/{task_id}/stop

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

Path Params

organization_id

string

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

account_id

string

required

Account id of the CloudRanger Account that you are managing inside an organization, these can be found by call the /organizations/{organization_id}/accounts endpoints which returns all accounts inside an Organization These are randomly generated alphanumber values

task_id

string

required

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

Body Params

Task Info

organization_id

string

timezone_location

string

name

string

description

string

inherit_tags

boolean

schedule_cron

string

is_active

boolean

is_fls_indexed

boolean

fls_index_freq

string

created_by

string

created_at

date-time

updated_at

date-time

deleted_at

string

retention

object

tag_with

array of strings

tag_with

copies

object

s3_archive

object

resource_options

object

encryption_mappings

array of strings

encryption_mappings

rules

array of objects

rules

Responses

Language

Credentials


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.cloudranger.com/202004/organizations/organization_id/accounts/account_id/tasks/task_id/stop \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 response

201201 response

401401 response

403403 response

404404 response