Apache Airflow

Apache Airflow Task Instance API

The Task Instance API from Apache Airflow — 9 operation(s) for task instance.

GitHub OpenAPI

Operations 38

GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} Get Task Instance #
PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} Patch Task Instance #
DELETE /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} Delete Task Instance #
GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/listMapped Get Mapped Task Instances #
GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/dependencies Get Task Instance Dependencies #
GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/dependencies Get Task Instance Dependencies #
GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/tries Get Task Instance Tries #
GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/tries Get Mapped Task Instance Tries #
GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index} Get Mapped Task Instance #
PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index} Patch Task Instance #
GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances Get Task Instances #
PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances Bulk Task Instances #
POST /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/list Get Task Instances Batch #
GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/tries/{task_try_number} Get Task Instance Try Details #
GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/tries/{task_try_number} Get Mapped Task Instance Try Details #
POST /api/v2/dags/{dag_id}/clearTaskInstances Post Clear Task Instances #
PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskGroupInstances/{group_id} Patch Task Group Instances #
PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskGroupInstances/{group_id}/dry_run Patch Task Group Instances Dry Run #
PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/dry_run Patch Task Instance Dry Run #
PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/dry_run Patch Task Instance Dry Run #
GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{try_number} Get Log #
GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/externalLogUrl/{try_number} Get External Log Url #
PATCH /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/hitlDetails Update Hitl Detail #
GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/hitlDetails Get Hitl Detail #
GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/hitlDetails/tries/{try_number} Get Hitl Detail Try Detail #
GET /api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/hitlDetails Get Hitl Details #
GET /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances Apache Airflow List Task Instances #
GET /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} Apache Airflow Get a Task Instance #
PATCH /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id} Apache Airflow Updates the State of a Task Instance #
GET /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/listMapped Apache Airflow List Mapped Task Instances #
GET /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{task_try_number} Apache Airflow Get Logs #
PATCH /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/setNote Apache Airflow Update the TaskInstance Note #
GET /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index} Apache Airflow Get a Mapped Task Instance #
PATCH /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index} Apache Airflow Updates the State of a Mapped Task Instance #
PATCH /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/setNote Apache Airflow Update the TaskInstance Note #
POST /dags/~/dagRuns/~/taskInstances/list Apache Airflow List Task Instances (batch) #

Documentation

📖
Documentation
https://airflow.apache.org/docs/apache-airflow/stable/stable-rest-api-ref.html
📖
Authentication
https://airflow.apache.org/docs/apache-airflow/stable/security/api.html

Specifications

⚙
OpenAPI
https://artifacts.apis.io/apache-airflow/openapi/apache-airflow-task-instance-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://artifacts.apis.io/apache-airflow/errors/apache-airflow-problem-types.yml
🔗
ChangeLog
https://airflow.apache.org/docs/apache-airflow/stable/release_notes.html

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/apache-airflow:apache-airflow-task-instance-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

apache-airflow-task-instance-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Airflow Task Instance API
  description: 'Airflow API. All endpoints located under ``/api/v2`` can be used safely, are stable and backward compatible. Endpoints located under ``/ui`` are dedicated to the UI and are subject to breaking change depending on the need of the frontend. Users should not rely on those but use the public ones instead.


    **Filtering with pattern parameters.** Many list endpoints accept ``*_pattern`` and ``*_prefix_pattern`` query parameters. Unless a parameter''s own description says otherwise, ``*_pattern`` is a case-insensitive substring match (SQL ``ILIKE ''%term%''``) where ``%`` matches any sequence and ``_`` matches any single character (e.g. ``%customer_%``) — convenient, but it cannot use B-tree indexes, so it is slow on large tables. ``*_prefix_pattern`` matches the start of the value, is case-sensitive and index-friendly (prefer it at scale); there ``%`` and ``_`` are literal and trailing non-alphanumeric characters are stripped so the range scan stays index-compatible under locale-aware collations (e.g. ``test_`` matches values starting with ``test``, and ``s3://`` matches ``s3``). In both, ``|`` means OR (e.g. ``dag1|dag2``) and ``~`` matches everything. Regular expressions are not supported by these parameters; regex-capable endpoints expose a separate parameter.'
  version: '2'
tags:


# --- truncated at 32 KB (156 KB total) ---
# Full source: https://artifacts.apis.io/apache-airflow/openapi/apache-airflow-task-instance-api-openapi.yml