Go API client for airflow

Apache Airflow management API.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://airflow.apache.org

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./airflow"

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v1

ClassMethodHTTP requestDescription
ConfigApiGetConfigGet /configGet current configuration
ConnectionApiDeleteConnectionDelete /connections/{connection_id}Delete a connection entry
ConnectionApiGetConnectionGet /connections/{connection_id}Get a connection entry
ConnectionApiGetConnectionsGet /connectionsGet all connection entries
ConnectionApiPatchConnectionPatch /connections/{connection_id}Update a connection entry
ConnectionApiPostConnectionPost /connectionsCreate connection entry
DAGApiGetDagGet /dags/{dag_id}Get basic information about a DAG
DAGApiGetDagDetailsGet /dags/{dag_id}/detailsGet a simplified representation of DAG
DAGApiGetDagSourceGet /dagSources/{file_token}Get source code using file token
DAGApiGetDagsGet /dagsGet all DAGs
DAGApiGetTaskGet /dags/{dag_id}/tasks/{task_id}Get simplified representation of a task
DAGApiGetTasksGet /dags/{dag_id}/tasksGet tasks for DAG
DAGApiPatchDagPatch /dags/{dag_id}Update a DAG
DAGApiPostClearTaskInstancesPost /dags/{dag_id}/clearTaskInstancesClears a set of task instances associated with the DAG for a specified date range.
DAGRunApiDeleteDagRunDelete /dags/{dag_id}/dagRuns/{dag_run_id}Delete a DAG Run
DAGRunApiGetDagRunGet /dags/{dag_id}/dagRuns/{dag_run_id}Get a DAG Run
DAGRunApiGetDagRunsGet /dags/{dag_id}/dagRunsGet all DAG Runs
DAGRunApiGetDagRunsBatchPost /dags/~/dagRuns/listGet all DAG Runs from all DAGs
DAGRunApiPostDagRunPost /dags/{dag_id}/dagRunsTrigger a DAG Run
EventLogApiGetEventLogGet /eventLogs/{event_log_id}Get a log entry
EventLogApiGetEventLogsGet /eventLogsGet all log entries from event log
ImportErrorApiGetImportErrorGet /importErrors/{import_error_id}Get an import error
ImportErrorApiGetImportErrorsGet /importErrorsGet all import errors
MonitoringApiGetHealthGet /healthReturns the status of Airflow's metadatabase and scheduler
MonitoringApiGetVersionGet /versionGet version information
PoolApiDeletePoolDelete /pools/{pool_name}Delete a pool
PoolApiGetPoolGet /pools/{pool_name}Get a pool
PoolApiGetPoolsGet /poolsGet all pools
PoolApiPatchPoolPatch /pools/{pool_name}Update a pool
PoolApiPostPoolPost /poolsCreate a pool
TaskInstanceApiGetExtraLinksGet /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/linksGet extra links for task instance
TaskInstanceApiGetLogGet /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/logs/{task_try_number}Get logs for a task instance
TaskInstanceApiGetTaskInstanceGet /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}Get a task instance
TaskInstanceApiGetTaskInstancesGet /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstancesGet a list of task instance of DAG
TaskInstanceApiGetTaskInstancesBatchPost /dags//dagRuns//taskInstances/listGet list of task instances from all DAGs and DAG Runs.
VariableApiDeleteVariableDelete /variables/{variable_key}Delete variable
VariableApiGetVariableGet /variables/{variable_key}Get a variable by key
VariableApiGetVariablesGet /variablesGet all variables
VariableApiPatchVariablePatch /variables/{variable_key}Update a variable by key
VariableApiPostVariablesPost /variablesCreate a variable
XComApiGetXcomEntriesGet /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntriesGet all XCom entries
XComApiGetXcomEntryGet /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/xcomEntries/{xcom_key}Get an XCom entry

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

dev@airflow.apache.org