How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Apache Airflow TaskInstance API

The TaskInstance API from Apache Airflow — 9 operation(s) for taskinstance.

Apache Airflow TaskInstance API is one of 19 APIs that Apache Airflow publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Task Instance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a changelog.

This API exposes 11 operations across 9 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 3.0.

Requests are made against 2 base URLs: /api/v1, https://apache.local.

11 operations 9 paths 15 schemas 6 GET4 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0
Base URL
http://localhost:8080/api/v1
Authentication
HTTP Basic, OpenID Connect, HTTP Negotiate
License
Resource Areas
1

Authentication & Security 3

Apache Airflow TaskInstance API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (Basic). It supports OpenID Connect (GoogleOpenId) discovered at https://accounts.google.com/.well-known/openid-configuration. It uses HTTP negotiate authentication (Kerberos).

Paths & Operations 11

Across 9 paths, the API surfaces 11 operations — 6 GET, 4 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

TaskInstance 11
GET
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances
Apache Airflow List Task Instances
get_task_instances 15 params → 200401403
GET
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}
Apache Airflow Get a Task Instance
get_task_instance 3 params → 200401403404
PATCH
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}
Apache Airflow Updates the State of a Task Instance
patch_task_instance 3 params body → 200401403404
GET
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/links
Apache Airflow List Extra Links
get_extra_links 3 params → 200401403404
GET
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/listMapped
Apache Airflow List Mapped Task Instances
get_mapped_task_instances 17 params → 200401403404
GET
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{task_try_number}
Apache Airflow Get Logs
get_log 7 params → 200400401403404
PATCH
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/setNote
Apache Airflow Update the TaskInstance Note.
set_task_instance_note 3 params body → 200400401403404
GET
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}
Apache Airflow Get a Mapped Task Instance
get_mapped_task_instance 4 params → 200401403404
PATCH
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}
Apache Airflow Updates the State of a Mapped Task Instance
patch_mapped_task_instance 4 params body → 200401403404
PATCH
/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/setNote
Apache Airflow Update the TaskInstance Note.
set_mapped_task_instance_note 4 params body → 200400401403404
POST
/dags/~/dagRuns/~/taskInstances/list
Apache Airflow List Task Instances (batch)
get_task_instances_batch body → 200401403404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are TaskInstance (26 properties), ListTaskInstanceForm (12 properties), Job (10 properties), SLAMiss (7 properties). Each schema is shown below with its type and property counts.

TaskState
string
Task state. Changed in version 2.0.2: 'removed' is added as a possible value. Changed in version 2.2.0: 'deferred' is added as a possible value. Changed in ver…
ClassReference
object
Class reference
2 properties
TaskInstanceCollection
object
Collection of task instances. Changed in version 2.1.0: 'totalentries' field is added.
TaskInstanceReference
object
4 properties
ExtraLink
object
Additional links containing additional information about the task.
3 properties
ExtraLinkCollection
object
The collection of extra links.
1 property
Trigger
object
5 properties
SLAMiss
objectnull
7 properties
CollectionInfo
object
Metadata about collection.
1 property
Error
object
[RFC7807](https://tools.ietf.org/html/rfc7807) compliant response.
5 properties 3 required
Job
object
10 properties
TaskInstance
object
26 properties
ListTaskInstanceForm
object
12 properties
SetTaskInstanceNote
object
1 property 1 required
UpdateTaskInstance
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

apache-airflow-taskinstance-api-openapi.yml Raw ↑

Other APIs Apache Airflow publishes across the network.

Apache Airflow Experimental API (Deprecated)
Apache Airflow Config API
Apache Airflow Connection API
Apache Airflow DAG API
Apache Airflow DAGRun API
Apache Airflow DagWarning API
Apache Airflow Dataset API
Apache Airflow EventLog API
Apache Airflow ImportError API
Apache Airflow Monitoring API
Apache Airflow Permission API
Apache Airflow Plugin API
Where this information came from

This is an independent, third-party profile of Apache Airflow TaskInstance API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.