Skip to navigation
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.

Deleting the run’s input files also deletes the batch that the run processed.

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 deletion request accepted. The response contains a job ID for each file deletion that started, so a key is absent if you set its corresponding option to false. Poll each job ID to check completion status.

delete_input_dir_job_idstringOptional

Job ID for deleting the input directory. Returned only when delete_input is true and the deletion job started.

delete_output_dir_job_idstringOptional

Job ID for deleting the output directory. Returned only when delete_output is true and the deletion job started.

delete_log_dir_job_idstringOptional

Job ID for deleting the log directory. Returned only when delete_logs is true and the deletion job started.