Airflow Extended API, which export airflow CLI command as RESTful API to extend the ability of airflow official API.

1. Download plugins zip from:

https://github.com/caoergou/airflow-extended-api/archive/master.zip

2. Check the plugins_floder configuration in airflow.cfg.
   If not, consider use airflow default plugin dir path {AIRFLOW_HOME}/plugins as plugin floder.
3. Unzip the plugins zip, move folder /plugins/extended_api/ to plugins_floder directory.

unzip airflow-extended-api-plugin.zip

cp -r airflow-rest-api-plugin/plugins/extended_api/* {AIRFLOW_PLUGINS_FOLDER}

4. Start services of the airflow webserver and the airflow scheduler.

airflow webserver -p 8080
airflow scheduler

• /plugins
  • /extended_api
    • /extended_api.py - Airflow plugins, expose functions as RESTful API.
    • /utils.py - API DTO class and function to execute CLI command.
    • /index.html - Airflow Extended API specification static front-end page.
    • /openapi.yaml - Airflow Extended API specification yaml file in OpenAPI Specification style.

For convenience, these APIs does NOT require any authentication!

Therefore, if these APIs is directly exposed to the public network environment, it is equivalent to exposing the command line execution authority to public, which is a huge security risk.

So it For safety reasons, please think carefully about whether you need to keep this @csrf.exempt annotation.

• clear_task
• run_task

• use CLI command to clear a task for rerun.

https://{AIRFLOW_HOST}:{AIRFLOW_PORT}/api/extended/clear

• POST

Args for Airflow CLI command airflow tasks clear.

curl -X POST https://localhost:8080/api/extended/clear -H "Content-Type: application/json" -d '{"dagName": "string","downstream": true,"endDate": "2019-08-24T14:15:22Z","jobName": "string","startDate": "2019-08-24T14:15:22Z","username": "Knowhere API"}'

{
  "executed_command": "string",
  "exit_code": 0,
  "output_info": [
    "string"
  ],
  "error_info": [
    "string"
  ]
}

• Airflow configuration documentation
• Contact email
  • Eric CAO - [email protected]