Kill a Schedule Action

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-admin or system-user 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://gcp.qubole.com/api/v1.2/actions/${ACTIONID}/kill"

Response

{"kill_succeeded":"true"}