Skip to main content
POST
/
v1
/
ingestion
/
jobs
/
{job_id}
/
cancel
import olira

olira.init(api_key="YOUR_API_KEY")
job = olira.cancel_ingestion_job(job_id="ing-job-001")

IngestionJob(
    job_id="ing-job-001",
    status="cancelled",
    stage="cancelled",
)

olira.cancel_ingestion_job(job_id: str) -> IngestionJob
Requires scope: sdk:historical-ingest During awaiting_confirmation, STALE logs are deleted immediately; patients are deleted only if rollback_on_cancel=True. During replay/backfill, stops cooperatively — already-replayed patients are retained.

​
Parameters

​
job_id
str
required
Job id to cancel.

​
Returns

IngestionJob
​
job_id
str
Job id.
​
status
str
cancelled or cancelling.

​
Raises

ExceptionWhen
AuthErrorHTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint.
ValidationErrorHTTP 400, 404, or 422 — malformed JSON, unknown patient, or validation failure (message includes response excerpt).
ServerErrorHTTP 409 (e.g. conflicting external identifier) or repeated 5xx after retries; includes status_code when applicable.
RateLimitErrorHTTP 429 — rate limited; check retry_after (seconds).
NetworkErrorConnection timeout, DNS failure, or read error after retries.
import olira

olira.init(api_key="YOUR_API_KEY")
job = olira.cancel_ingestion_job(job_id="ing-job-001")

IngestionJob(
    job_id="ing-job-001",
    status="cancelled",
    stage="cancelled",
)