client.scripts.post_cancel

A method of the Scripts endpoint.

post_cancel(id: int) → Response

Cancel a run

API URL: POST /scripts/{id}/cancel

import civis
client = civis.APIClient()
response = client.scripts.post_cancel(...)

Parameters:

idint

The ID of the job.

Returns:

civis.Response

• idint

  The ID of the run.

• statestr

  The state of the run, one of ‘queued’, ‘running’ or ‘cancelled’.

• is_cancel_requestedbool

  True if run cancel requested, else false.