screening

Delete Run

Delete a bulk screening run and its results.

Permanently removes a completed or cancelled run and all associated screening results from the database. This action cannot be undone.

curl example:

curl -X DELETE "https://api.halalterminal.com/api/screen-bulk/abc123" \
     -H "X-API-Key: <API_KEY>"

Python requests example:

import requests

resp = requests.delete(
    "https://api.halalterminal.com/api/screen-bulk/abc123",
    headers={"X-API-Key": "<API_KEY>"},
)
print(resp.json())
delete/api/screen-bulk/{run_id}

Request

  • Base URL: https://api.halalterminal.com
  • URL: https://api.halalterminal.com/api/screen-bulk/{run_id}
  • Auth: API key in header X-API-Key

Path parameters

run_idstring required

Bulk-run ID returned by POST /api/screen-bulk.

Response

Confirmation that the run was deleted

run_idstring required
deletedboolean required

Whether the run was successfully deleted

Example response

{
  "deleted": true,
  "run_id": "run_2025-01-15_sp500"
}

Changes

No recorded changes to this operation across all 1 revision of this API.