ClearTaskInstances

ClearTaskInstances schema from Apache Airflow API

ApacheDAGData PipelineETLOpen SourceOrchestrationPythonSchedulingWorkflow

Properties

Name	Type	Description
dag_run_id	string	The DagRun ID for this task instance
dry_run	boolean	If set, don't actually run this operation. The response will contain a list of task instances planned to be cleaned, but not modified in any way.
end_date	string	The maximum execution date to clear.
include_downstream	boolean	If set to true, downstream tasks are also affected.
include_future	boolean	If set to True, also tasks from future DAG Runs are affected.
include_parentdag	boolean	Clear tasks in the parent dag of the subdag.
include_past	boolean	If set to True, also tasks from past DAG Runs are affected.
include_subdags	boolean	Clear tasks in subdags and clear external tasks indicated by ExternalTaskMarker.
include_upstream	boolean	If set to true, upstream tasks are also affected.
only_failed	boolean	Only clear failed tasks.
only_running	boolean	Only clear running tasks.
reset_dag_runs	boolean	Set state of DAG runs to RUNNING.
start_date	string	The minimum execution date to clear.
task_ids	array	A list of task ids to clear. New in version 2.1.0

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-airflow/refs/heads/main/json-schema/openapi.yaml-clear-task-instances-schema.json",
  "title": "ClearTaskInstances",
  "description": "ClearTaskInstances schema from Apache Airflow API",
  "type": "object",
  "properties": {
    "dag_run_id": {
      "description": "The DagRun ID for this task instance",
      "nullable": true,
      "type": "string"
    },
    "dry_run": {
      "default": true,
      "description": "If set, don't actually run this operation. The response will contain a list of task instances\nplanned to be cleaned, but not modified in any way.\n",
      "type": "boolean"
    },
    "end_date": {
      "description": "The maximum execution date to clear.",
      "format": "datetime",
      "type": "string"
    },
    "include_downstream": {
      "default": false,
      "description": "If set to true, downstream tasks are also affected.",
      "type": "boolean"
    },
    "include_future": {
      "default": false,
      "description": "If set to True, also tasks from future DAG Runs are affected.",
      "type": "boolean"
    },
    "include_parentdag": {
      "description": "Clear tasks in the parent dag of the subdag.",
      "type": "boolean"
    },
    "include_past": {
      "default": false,
      "description": "If set to True, also tasks from past DAG Runs are affected.",
      "type": "boolean"
    },
    "include_subdags": {
      "description": "Clear tasks in subdags and clear external tasks indicated by ExternalTaskMarker.",
      "type": "boolean"
    },
    "include_upstream": {
      "default": false,
      "description": "If set to true, upstream tasks are also affected.",
      "type": "boolean"
    },
    "only_failed": {
      "default": true,
      "description": "Only clear failed tasks.",
      "type": "boolean"
    },
    "only_running": {
      "default": false,
      "description": "Only clear running tasks.",
      "type": "boolean"
    },
    "reset_dag_runs": {
      "description": "Set state of DAG runs to RUNNING.",
      "type": "boolean"
    },
    "start_date": {
      "description": "The minimum execution date to clear.",
      "format": "datetime",
      "type": "string"
    },
    "task_ids": {
      "description": "A list of task ids to clear.\n\n*New in version 2.1.0*\n",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "type": "array"
    }
  }
}