Kill a Schedule Action on Microsoft Azure

PUT /api/v1.2/actions/(int: id)/kill

Cancels a running scheduled action. The ID can be obtained by listing the actions using any one of the list-schedule-actions or the list-all-actions.

Required Role

The following users can make this API call:

  • Users who belong to the system-user or system-admin group.

  • Users who belong to a group associated with a role that allows killing a schedule action. See Managing Groups and Managing Roles for more information.

Response

A JSON hash that encodes if the operation is a success or not.

{"kill_succeeded":"true"}

Example

Goal: Rerun an action with ID ${ACTIONID}

curl -i -X PUT -H "X-AUTH-TOKEN: $AUTH_TOKEN" \
-H "Accept: application/json" \
-H "Content-type: application/json" \
{"status":"kill"} \
"https://api.qubole.com/api/v1.2/actions/${ACTIONID}/kill"

Note

The above syntax uses https://api.qubole.com as the endpoint. Qubole provides other endpoints to access QDS that are described in Supported Qubole Endpoints on Different Cloud Providers.

Response

{"kill_succeeded":"true"}