The Asset API from Apache Airflow — 9 operation(s) for asset.
openapi: 3.1.0
info:
title: Airflow Asset 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.
version: '2'
tags:
- name: Asset
paths:
/api/v2/assets:
get:
tags:
- Asset
summary: Airflow Get Assets
description: Get assets.
operationId: get_assets
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
default: 50
title: Limit
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Offset
- name: name_pattern
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
title: Name Pattern
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
- name: uri_pattern
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
title: Uri Pattern
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
- name: dag_ids
in: query
required: false
schema:
type: array
items:
type: string
title: Dag Ids
- name: only_active
in: query
required: false
schema:
type: boolean
default: true
title: Only Active
- name: order_by
in: query
required: false
schema:
type: array
items:
type: string
description: 'Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, name, uri, created_at, updated_at`'
default:
- id
title: Order By
description: 'Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, name, uri, created_at, updated_at`'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AssetCollectionResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/assets/aliases:
get:
tags:
- Asset
summary: Airflow Get Asset Aliases
description: Get asset aliases.
operationId: get_asset_aliases
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
default: 50
title: Limit
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Offset
- name: name_pattern
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
title: Name Pattern
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
- name: order_by
in: query
required: false
schema:
type: array
items:
type: string
description: 'Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, name`'
default:
- id
title: Order By
description: 'Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `id, name`'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AssetAliasCollectionResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/assets/aliases/{asset_alias_id}:
get:
tags:
- Asset
summary: Airflow Get Asset Alias
description: Get an asset alias.
operationId: get_asset_alias
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: asset_alias_id
in: path
required: true
schema:
type: integer
title: Asset Alias Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/assets/events:
get:
tags:
- Asset
summary: Airflow Get Asset Events
description: Get asset events.
operationId: get_asset_events
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: limit
in: query
required: false
schema:
type: integer
minimum: 0
default: 50
title: Limit
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Offset
- name: order_by
in: query
required: false
schema:
type: array
items:
type: string
description: 'Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `source_task_id, source_dag_id, source_run_id, source_map_index, timestamp`'
default:
- timestamp
title: Order By
description: 'Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `source_task_id, source_dag_id, source_run_id, source_map_index, timestamp`'
- name: asset_id
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Asset Id
- name: source_dag_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Source Dag Id
- name: source_task_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Source Task Id
- name: source_run_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Source Run Id
- name: source_map_index
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Source Map Index
- name: name_pattern
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
title: Name Pattern
description: SQL LIKE expression — use `%` / `_` wildcards (e.g. `%customer_%`). or the pipe `|` operator for OR logic (e.g. `dag1 | dag2`). Regular expressions are **not** supported.
- name: timestamp_gte
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Timestamp Gte
- name: timestamp_gt
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Timestamp Gt
- name: timestamp_lte
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Timestamp Lte
- name: timestamp_lt
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Timestamp Lt
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AssetEventCollectionResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
tags:
- Asset
summary: Airflow Create Asset Event
description: Create asset events.
operationId: create_asset_event
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAssetEventsBody'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AssetEventResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/assets/{asset_id}/materialize:
post:
tags:
- Asset
summary: Airflow Materialize Asset
description: Materialize an asset by triggering a DAG run that produces it.
operationId: materialize_asset
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: asset_id
in: path
required: true
schema:
type: integer
title: Asset Id
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/MaterializeAssetBody'
- type: 'null'
title: Body
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DAGRunResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Conflict
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/assets/{asset_id}/queuedEvents:
get:
tags:
- Asset
summary: Airflow Get Asset Queued Events
description: Get queued asset events for an asset.
operationId: get_asset_queued_events
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: asset_id
in: path
required: true
schema:
type: integer
title: Asset Id
- name: before
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Before
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/QueuedEventCollectionResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
tags:
- Asset
summary: Airflow Delete Asset Queued Events
description: Delete queued asset events for an asset.
operationId: delete_asset_queued_events
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: asset_id
in: path
required: true
schema:
type: integer
title: Asset Id
- name: before
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Before
responses:
'204':
description: Successful Response
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/assets/{asset_id}:
get:
tags:
- Asset
summary: Airflow Get Asset
description: Get an asset.
operationId: get_asset
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: asset_id
in: path
required: true
schema:
type: integer
title: Asset Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AssetResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/dags/{dag_id}/assets/queuedEvents:
get:
tags:
- Asset
summary: Airflow Get Dag Asset Queued Events
description: Get queued asset events for a DAG.
operationId: get_dag_asset_queued_events
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
type: string
title: Dag Id
- name: before
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Before
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/QueuedEventCollectionResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
tags:
- Asset
summary: Airflow Delete Dag Asset Queued Events
operationId: delete_dag_asset_queued_events
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
type: string
title: Dag Id
- name: before
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Before
responses:
'204':
description: Successful Response
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/api/v2/dags/{dag_id}/assets/{asset_id}/queuedEvents:
get:
tags:
- Asset
summary: Airflow Get Dag Asset Queued Event
description: Get a queued asset event for a DAG.
operationId: get_dag_asset_queued_event
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
type: string
title: Dag Id
- name: asset_id
in: path
required: true
schema:
type: integer
title: Asset Id
- name: before
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Before
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/QueuedEventResponse'
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
tags:
- Asset
summary: Airflow Delete Dag Asset Queued Event
description: Delete a queued asset event for a DAG.
operationId: delete_dag_asset_queued_event
security:
- OAuth2PasswordBearer: []
- HTTPBearer: []
parameters:
- name: dag_id
in: path
required: true
schema:
type: string
title: Dag Id
- name: asset_id
in: path
required: true
schema:
type: integer
title: Asset Id
- name: before
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Before
responses:
'204':
description: Successful Response
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Forbidden
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPExceptionResponse'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
CreateAssetEventsBody:
properties:
asset_id:
type: integer
title: Asset Id
partition_key:
anyOf:
- type: string
- type: 'null'
title: Partition Key
extra:
additionalProperties: true
type: object
title: Extra
additionalProperties: false
type: object
required:
- asset_id
title: CreateAssetEventsBody
description: Create asset events request.
DagRunType:
type: string
enum:
- backfill
- scheduled
- manual
- operator_triggered
- asset_triggered
- asset_materialization
title: DagRunType
description: Class with DagRun types.
DAGRunResponse:
properties:
dag_run_id:
type: string
title: Dag Run Id
dag_id:
type: string
title: Dag Id
logical_date:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Logical Date
queued_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Queued At
start_date:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Start Date
end_date:
anyOf:
- type: string
format: date-time
- type: 'null'
title: End Date
duration:
anyOf:
- type: number
- type: 'null'
title: Duration
data_interval_start:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Data Interval Start
data_interval_end:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Data Interval End
run_after:
type: string
format: date-time
title: Run After
last_scheduling_decision:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Last Scheduling Decision
run_type:
$ref: '#/components/schemas/DagRunType'
state:
$ref: '#/components/schemas/DagRunState'
triggered_by:
anyOf:
- $ref: '#/components/schemas/DagRunTriggeredByType'
- type: 'null'
triggering_user_name:
anyOf:
- type: string
- type: 'null'
title: Triggering User Name
conf:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Conf
note:
anyOf:
- type: string
- type: 'null'
title: Note
dag_versions:
items:
$ref: '#/components/schemas/DagVersionResponse'
type: array
title: Dag Versions
bundle_version:
anyOf:
- type: string
- type: 'null'
title: Bundle Version
dag_display_name:
type: string
title: Dag Display Name
partition_key:
anyOf:
- type: string
- type: 'null'
title: Partition Key
type: object
required:
- dag_run_id
- dag_id
- logical_date
- queued_at
- start_date
- end_date
- duration
- data_interval_start
- data_interval_end
- run_after
- last_scheduling_decision
- run_type
- state
- triggered_by
- triggering_user_name
- conf
- note
- dag_versions
- bundle_version
- dag_display_name
- partition_key
title: DAGRunResponse
description: DAG Run serializer for responses.
AssetCollectionResponse:
properties:
assets:
items:
$ref: '#/components/schemas/AssetResponse'
type: array
title: Assets
total_entries:
type: integer
title: Total Entries
type: object
required:
- assets
- total_entries
title: AssetCollectionResponse
description: Asset collection response.
LastAssetEventResponse:
properties:
id:
anyOf:
- type: integer
minimum: 0.0
- type: 'null'
title: Id
timestamp:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Timestamp
type: object
title: LastAssetEventResponse
description: Last asset event response serializer.
MaterializeAssetBody:
properties:
dag_run_id:
anyOf:
- type: string
-
# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/airflow/refs/heads/main/openapi/airflow-asset-api-openapi.yml