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 Task Instance API

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

Apache Airflow Task Instance API is one of 26 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, an API reference, and authentication docs.

This API exposes 25 operations across 20 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version 2.

Requests are made against a single base URL, http://localhost:8080/api/v2.

25 operations 20 paths 35 schemas 1 DELETE16 GET6 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2
Base URL
http://localhost:8080/api/v2
Authentication
OAuth 2.0, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Apache Airflow Task Instance API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2PasswordBearer) using the password flow. It accepts HTTP bearer tokens (HTTPBearer).

  • OAuth2PasswordBearer — To authenticate Airflow API requests, clients must include a JWT (JSON Web Token) in the Authorization header of each request. This token is used to verify the…

Paths & Operations 25

Across 20 paths, the API surfaces 25 operations — 1 DELETE, 16 GET, 6 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Task Instance 25
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/links
Airflow Get Extra Links
get_extra_links 4 params → 200401403404422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}
Airflow Get Task Instance
get_task_instance 3 params → 200401403404422
PATCH
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}
Airflow Patch Task Instance
patch_task_instance 5 params body → 200401403400404409422
DELETE
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}
Airflow Delete Task Instance
delete_task_instance 4 params → 200401403404422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/listMapped
Airflow Get Mapped Task Instances
get_mapped_task_instances 41 params → 200401403404422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/dependencies
Airflow Get Task Instance Dependencies
get_task_instance_dependencies_by_map_index 4 params → 200401403404422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/dependencies
Airflow Get Task Instance Dependencies
get_task_instance_dependencies 4 params → 200401403404422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/tries
Airflow Get Task Instance Tries
get_task_instance_tries 4 params → 200401403404422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/tries
Airflow Get Mapped Task Instance Tries
get_mapped_task_instance_tries 4 params → 200401403404422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}
Airflow Get Mapped Task Instance
get_mapped_task_instance 4 params → 200401403404422
PATCH
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}
Airflow Patch Task Instance
patch_task_instance_by_map_index 5 params body → 200401403400404409422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances
Airflow Get Task Instances
get_task_instances 46 params → 200401403400404422
PATCH
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances
Airflow Bulk Task Instances
bulk_task_instances 2 params body → 200401403422
POST
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/list
Airflow Get Task Instances Batch
get_task_instances_batch 2 params body → 200401403404422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/tries/{task_try_number}
Airflow Get Task Instance Try Details
get_task_instance_try_details 5 params → 200401403404422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/tries/{task_try_number}
Airflow Get Mapped Task Instance Try Details
get_mapped_task_instance_try_details 5 params → 200401403404422
POST
/api/v2/dags/{dag_id}/clearTaskInstances
Airflow Post Clear Task Instances
post_clear_task_instances 1 param body → 200401403404409422
PATCH
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/dry_run
Airflow Patch Task Instance Dry Run
patch_task_instance_dry_run_by_map_index 5 params body → 200401403400404422
PATCH
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/dry_run
Airflow Patch Task Instance Dry Run
patch_task_instance_dry_run 5 params body → 200401403400404422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{try_number}
Airflow Get Log
get_log 8 params → 200401403404422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/externalLogUrl/{try_number}
Airflow Get External Log Url
get_external_log_url 5 params → 200401403400404422
PATCH
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/hitlDetails
Airflow Update Hitl Detail
update_hitl_detail 4 params body → 200401403404409422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/hitlDetails
Airflow Get Hitl Detail
get_hitl_detail 4 params → 200401403404422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index}/hitlDetails/tries/{try_number}
Airflow Get Hitl Detail Try Detail
get_hitl_detail_try_detail 5 params → 200401403404422
GET
/api/v2/dags/{dag_id}/dagRuns/{dag_run_id}/hitlDetails
Airflow Get Hitl Details
get_hitl_details 19 params → 200401403422

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are TaskInstanceResponse (34 properties), TaskInstancesBatchBody (30 properties), TaskInstanceHistoryResponse (26 properties), ClearTaskInstancesBody (15 properties). Each schema is shown below with its type and property counts.

TaskInstanceCollectionResponse
object
Task instance collection response supporting both offset and cursor pagination. A single flat model is used instead of a discriminated union (Annotated[Offset…
4 properties 1 required
HTTPValidationError
object
1 property
BulkActionOnExistence
string
Bulk Action to be taken if the entity already exists or not.
ExternalLogUrlResponse
object
Response for the external log URL endpoint.
1 property 1 required
TaskDependencyCollectionResponse
object
Task scheduling dependencies collection serializer for responses.
1 property 1 required
BulkBody_BulkTaskInstanceBody_
object
1 property 1 required
BulkDeleteAction_BulkTaskInstanceBody_
object
3 properties 2 required
DagVersionResponse
object
Dag Version serializer for responses.
8 properties 8 required
HTTPExceptionResponse
object
HTTPException Model used for error response.
1 property 1 required
HITLDetailResponse
object
Response of updating a Human-in-the-loop detail.
4 properties 3 required
ClearTaskInstancesBody
object
Request body for Clear Task Instances endpoint.
15 properties
BulkActionNotOnExistence
string
Bulk Action to be taken if the entity does not exist.
TaskInstancesLogResponse
object
Log serializer for responses.
2 properties 2 required
HITLDetailHistory
object
Schema for Human-in-the-loop detail history.
14 properties 4 required
BulkUpdateAction_BulkTaskInstanceBody_
object
4 properties 2 required
StructuredLogMessage
object
An individual log message.
2 properties 1 required
JobResponse
object
Job serializer for responses.
11 properties 10 required
TriggerResponse
object
Trigger serializer for responses.
6 properties 6 required
HITLDetailCollection
object
Schema for a collection of Human-in-the-loop details.
2 properties 2 required
BulkActionResponse
object
Serializer for individual bulk action responses. Represents the outcome of a single bulk operation (create, update, or delete). The response includes a list of…
2 properties
ExtraLinkCollectionResponse
object
Extra Links Response.
2 properties 2 required
TaskInstanceState
string
All possible states that a Task Instance can be in. Note that None is also allowed, so always use this in a type hint with Optional.
PatchTaskInstanceBody
object
Request body for Clear Task Instances endpoint.
6 properties
ValidationError
object
5 properties 3 required
TaskDependencyResponse
object
Task Dependency serializer for responses.
2 properties 2 required
HITLUser
object
Schema for a Human-in-the-loop users.
2 properties 2 required
BulkCreateAction_BulkTaskInstanceBody_
object
3 properties 2 required
TaskInstanceResponse
object
TaskInstance serializer for responses.
34 properties 33 required
UpdateHITLDetailPayload
object
Schema for updating the content of a Human-in-the-loop detail.
2 properties 1 required
TaskInstanceHistoryCollectionResponse
object
TaskInstanceHistory Collection serializer for responses.
2 properties 2 required
TaskInstanceHistoryResponse
object
TaskInstanceHistory serializer for responses.
26 properties 26 required
TaskInstancesBatchBody
object
Task Instance body for get batch.
30 properties
BulkResponse
object
Serializer for responses to bulk entity operations. This represents the results of create, update, and delete actions performed on entity in bulk. Each action…
3 properties
BulkTaskInstanceBody
object
Request body for bulk update, and delete task instances.
10 properties 1 required
HITLDetail
object
Schema for Human-in-the-loop detail.
14 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

airflow-task-instance-api-openapi.yml Raw ↑

Other APIs Apache Airflow publishes across the network.

Apache Airflow Asset API
Apache Airflow Backfill API
Apache Airflow Config API
Apache Airflow Connection API
Apache Airflow DAG API
Apache Airflow DAG Parsing API
Apache Airflow DagRun API
Apache Airflow DagSource API
Apache Airflow DagStats API
Apache Airflow DagVersion API
Apache Airflow DagWarning API
Apache Airflow Event Log API
Where this information came from

This is an independent, third-party profile of Apache Airflow Task Instance 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.