Presents only information available in database (DAGModel). If you need detailed information, consider using GET /dags/{dag_id}/details.
643 matches
67 actions
Airflow API (Stable)
67 actions
- Clear a DAG runPOSTv1.0.0
- Clear a set of task instancesPOSTv1.0.0
- Create a connectionPOSTv1.0.0
- Create a poolPOSTv1.0.0
- Create a rolePOSTv1.0.0
- Create a userPOSTv1.0.0
- Create a variablePOSTv1.0.0
- Delete a connectionDELETEv1.0.0
- Delete a DAGDELETEv1.0.0
- Delete a DAG runDELETEv1.0.0
- Delete a poolDELETEv1.0.0
- Delete a roleDELETEv1.0.0
- Delete a userDELETEv1.0.0
- Delete a variableDELETEv1.0.0
- Get a connectionGETv1.0.0
- Get a DAG runGETv1.0.0
- Get a datasetGETv1.0.0
- Get a list of loaded pluginsGETv1.0.0
- Get a log entryGETv1.0.0
- Get a mapped task instanceGETv1.0.0
- Get a poolGETv1.0.0
- Get a roleGETv1.0.0
- Get a simplified representation of DAGGETv1.0.0
- Get a source codeGETv1.0.0
- Get a task instanceGETv1.0.0
- Get a userGETv1.0.0
- Get a variableGETv1.0.0
- Get an XCom entryGETv1.0.0
- Get basic information about a DAGGETv1.0.0
- Get current configurationGETv1.0.0
- Get dataset eventsGETv1.0.0
- Get dataset events for a DAG runGETv1.0.0
- Get logsGETv1.0.0
- Get simplified representation of a taskGETv1.0.0
- Get tasks for DAGGETv1.0.0
- List connectionsGETv1.0.0
- List DAG runsGETv1.0.0
- List dag warningsGETv1.0.0
- List DAGsGETv1.0.0
- List datasetsGETv1.0.0
- List extra linksGETv1.0.0
- List log entriesGETv1.0.0
- List mapped task instancesGETv1.0.0
- List permissionsGETv1.0.0
- List poolsGETv1.0.0
- List providersGETv1.0.0
- List rolesGETv1.0.0
- List task instancesGETv1.0.0
- List usersGETv1.0.0
- List variablesGETv1.0.0
- List XCom entriesGETv1.0.0
- Modify a DAG runPATCHv1.0.0
- Set a state of task instancesPOSTv1.0.0
- Test a connectionPOSTv1.0.0
- Trigger a new DAG runPOSTv1.0.0
- Update a connectionPATCHv1.0.0
- Update a DAGPATCHv1.0.0
- Update a poolPATCHv1.0.0
- Update a rolePATCHv1.0.0
- Update a userPATCHv1.0.0
- Update a variablePATCHv1.0.0
- Update DAGsPATCHv1.0.0
- Update the DagRun note.PATCHv1.0.0
- Update the TaskInstance note.PATCHv1.0.0
- Update the TaskInstance note.PATCHv1.0.0
- Updates the state of a mapped task instancePATCHv1.0.0
- Updates the state of a task instancePATCHv1.0.0
Communication/Airflow API (Stable)
Get basic information about a DAG
v1.0.0Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
{
"type": "object",
"description": "DAG",
"properties": {
"dag_id": {
"type": "string",
"description": "The ID of the DAG."
},
"default_view": {
"type": "string",
"description": "Default view of the DAG inside the webserver\n\n*New in version 2.3.0*\n"
},
"description": {
"type": "string",
"description": "User-provided DAG description, which can consist of several sentences or paragraphs that describe DAG contents.\n"
},
"file_token": {
"type": "string",
"description": "The key containing the encrypted path to the file. Encryption and decryption take place only on the server. This prevents the client from reading an non-DAG file. This also ensures API extensibility, because the format of encrypted data may change.\n"
},
"fileloc": {
"type": "string",
"description": "The absolute path to the file."
},
"has_import_errors": {
"type": "boolean",
"description": "Whether the DAG has import errors\n\n*New in version 2.3.0*\n"
},
"has_task_concurrency_limits": {
"type": "boolean",
"description": "Whether the DAG has task concurrency limits\n\n*New in version 2.3.0*\n"
},
"is_active": {
"type": "boolean",
"description": "Whether the DAG is currently seen by the scheduler(s).\n\n*New in version 2.1.1*\n\n*Changed in version 2.2.0*: Field is read-only.\n"
},
"is_paused": {
"type": "boolean",
"description": "Whether the DAG is paused."
},
"is_subdag": {
"type": "boolean",
"description": "Whether the DAG is SubDAG."
},
"last_expired": {
"type": "string",
"format": "date-time",
"description": "Time when the DAG last received a refresh signal\n(e.g. the DAG's \"refresh\" button was clicked in the web UI)\n\n*New in version 2.3.0*\n"
},
"last_parsed_time": {
"type": "string",
"format": "date-time",
"description": "The last time the DAG was parsed.\n\n*New in version 2.3.0*\n"
},
"last_pickled": {
"type": "string",
"format": "date-time",
"description": "The last time the DAG was pickled.\n\n*New in version 2.3.0*\n"
},
"max_active_runs": {
"type": "integer",
"description": "Maximum number of active DAG runs for the DAG\n\n*New in version 2.3.0*\n"
},
"max_active_tasks": {
"type": "integer",
"description": "Maximum number of active tasks that can be run on the DAG\n\n*New in version 2.3.0*\n"
},
"next_dagrun": {
"type": "string",
"format": "date-time",
"description": "The logical date of the next dag run.\n\n*New in version 2.3.0*\n"
},
"next_dagrun_create_after": {
"type": "string",
"format": "date-time",
"description": "Earliest time at which this ``next_dagrun`` can be created.\n\n*New in version 2.3.0*\n"
},
"next_dagrun_data_interval_end": {
"type": "string",
"format": "date-time",
"description": "The end of the interval of the next dag run.\n\n*New in version 2.3.0*\n"
},
"next_dagrun_data_interval_start": {
"type": "string",
"format": "date-time",
"description": "The start of the interval of the next dag run.\n\n*New in version 2.3.0*\n"
},
"owners": {
"type": "array",
"items": {
"type": "string"
}
},
"pickle_id": {
"type": "string",
"description": "Foreign key to the latest pickle_id\n\n*New in version 2.3.0*\n"
},
"root_dag_id": {
"type": "string",
"description": "If the DAG is SubDAG then it is the top level DAG identifier. Otherwise, null."
},
"schedule_interval": {
"description": "Schedule interval. Defines how often DAG runs, this object gets added to your latest task instance's\nexecution_date to figure out the next schedule.\n",
"type": "object"
},
"scheduler_lock": {
"type": "boolean",
"description": "Whether (one of) the scheduler is scheduling this DAG at the moment\n\n*New in version 2.3.0*\n"
},
"tags": {
"type": "array",
"description": "List of tags.",
"items": {
"type": "object",
"description": "Tag",
"properties": {
"name": {
"type": "string"
}
}
}
},
"timetable_description": {
"type": "string",
"description": "Timetable/Schedule Interval description.\n\n*New in version 2.3.0*\n"
}
}
}