API referenceRuns

Delete run

Deletes a specified 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.

Path parameters

run_idstringRequired

The run ID.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

IB-ContextstringOptional

Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. 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 nullOptional

Job ID for deleting the input directory.

delete_output_dir_job_idstring or nullOptional

Job ID for deleting the output directory.

delete_log_dir_job_idstring or nullOptional

Job ID for deleting the log directory.