API referenceRuns

Delete run

Deletes a specified automation app run and optionally its associated database data, input files, output files, and logs. This is an asynchronous operation that must be [checked for completion](/api-sdk/api-reference/jobs/job-status). <Warning>Deleting the run's input files also deletes the batch that the run processed.</Warning>

Authentication

AuthorizationBearer
Bearer HTTP authentication.

Path parameters

run_idstringRequired
The run ID.

Headers

IB-ContextstringOptional

Typically your organization ID. See Authorization and context identification for details.

Query parameters

delete_db_databooleanOptionalDefaults to true
Delete the run's database data.
delete_inputbooleanOptionalDefaults to true
Delete the run's input files.
delete_outputbooleanOptionalDefaults to true
Delete the run's output files.
delete_logsbooleanOptionalDefaults to true
Delete the run's logs.

Response

Run deleted successfully.
delete_input_dir_job_idstring or null
Job ID for deleting the input directory.
delete_output_dir_job_idstring or null
Job ID for deleting the output directory.
delete_log_dir_job_idstring or null
Job ID for deleting the log directory.