v2

latestOpenAPI 3.1.02026-08-06276982.8 KB
runs

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.

<Warning>Deleting the run's input files also deletes the batch that the run processed.</Warning>

delete/v2/apps/runs/{run_id}

Path parameters

run_idstring required

The run ID.

Query parameters

delete_db_databoolean

Delete the run's database data.

delete_inputboolean

Delete the run's input files.

delete_outputboolean

Delete the run's output files.

delete_logsboolean

Delete the run's logs.

Headers

Authorizationstring required

Bearer HTTP authentication.

IB-Contextstring

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

Response

Run deleted successfully.

delete_input_dir_job_idstring nullable

Job ID for deleting the input directory.

delete_output_dir_job_idstring nullable

Job ID for deleting the output directory.

delete_log_dir_job_idstring nullable

Job ID for deleting the log directory.