All URIs are relative to http://localhost/api/v1
Method | HTTP request | Description |
---|---|---|
delete_connection | DELETE /connections/{connection_id} | Delete a connection |
get_connection | GET /connections/{connection_id} | Get a connection |
get_connections | GET /connections | List connections |
patch_connection | PATCH /connections/{connection_id} | Update a connection |
post_connection | POST /connections | Create a connection |
delete_connection(connection_id)
Delete a connection
import time import airflow_client.client from airflow_client.client.api import connection_api from airflow_client.client.model.error import Error from pprint import pprint # Defining the host is optional and defaults to http://localhost/api/v1 # See configuration.py for a list of all supported configuration parameters. configuration = client.Configuration( host = "http://localhost/api/v1" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure HTTP basic authorization: Basic configuration = client.Configuration( username = 'YOUR_USERNAME', password = 'YOUR_PASSWORD' ) # Enter a context with an instance of the API client with client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = connection_api.ConnectionApi(api_client) connection_id = "connection_id_example" # str | The connection ID. # example passing only required values which don't have defaults set try: # Delete a connection api_instance.delete_connection(connection_id) except client.ApiException as e: print("Exception when calling ConnectionApi->delete_connection: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
connection_id | str | The connection ID. |
void (empty response body)
Status code | Description | Response headers |
---|---|---|
204 | Success. | - |
400 | Client specified an invalid argument. | - |
401 | Request not authenticated due to missing, invalid, authentication info. | - |
403 | Client does not have sufficient permission. | - |
404 | A specified resource is not found. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Connection get_connection(connection_id)
Get a connection
import time import airflow_client.client from airflow_client.client.api import connection_api from airflow_client.client.model.connection import Connection from airflow_client.client.model.error import Error from pprint import pprint # Defining the host is optional and defaults to http://localhost/api/v1 # See configuration.py for a list of all supported configuration parameters. configuration = client.Configuration( host = "http://localhost/api/v1" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure HTTP basic authorization: Basic configuration = client.Configuration( username = 'YOUR_USERNAME', password = 'YOUR_PASSWORD' ) # Enter a context with an instance of the API client with client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = connection_api.ConnectionApi(api_client) connection_id = "connection_id_example" # str | The connection ID. # example passing only required values which don't have defaults set try: # Get a connection api_response = api_instance.get_connection(connection_id) pprint(api_response) except client.ApiException as e: print("Exception when calling ConnectionApi->get_connection: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
connection_id | str | The connection ID. |
Status code | Description | Response headers |
---|---|---|
200 | Success. | - |
401 | Request not authenticated due to missing, invalid, authentication info. | - |
403 | Client does not have sufficient permission. | - |
404 | A specified resource is not found. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object get_connections()
List connections
import time import airflow_client.client from airflow_client.client.api import connection_api from airflow_client.client.model.error import Error from pprint import pprint # Defining the host is optional and defaults to http://localhost/api/v1 # See configuration.py for a list of all supported configuration parameters. configuration = client.Configuration( host = "http://localhost/api/v1" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure HTTP basic authorization: Basic configuration = client.Configuration( username = 'YOUR_USERNAME', password = 'YOUR_PASSWORD' ) # Enter a context with an instance of the API client with client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = connection_api.ConnectionApi(api_client) limit = 100 # int | The numbers of items to return. (optional) if omitted the server will use the default value of 100 offset = 0 # int | The number of items to skip before starting to collect the result set. (optional) # example passing only required values which don't have defaults set # and optional values try: # List connections api_response = api_instance.get_connections(limit=limit, offset=offset) pprint(api_response) except client.ApiException as e: print("Exception when calling ConnectionApi->get_connections: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
limit | int | The numbers of items to return. | [optional] if omitted the server will use the default value of 100 |
offset | int | The number of items to skip before starting to collect the result set. | [optional] |
object
Status code | Description | Response headers |
---|---|---|
200 | Success. | - |
401 | Request not authenticated due to missing, invalid, authentication info. | - |
403 | Client does not have sufficient permission. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Connection patch_connection(connection_id, connection)
Update a connection
import time import airflow_client.client from airflow_client.client.api import connection_api from airflow_client.client.model.connection import Connection from airflow_client.client.model.error import Error from pprint import pprint # Defining the host is optional and defaults to http://localhost/api/v1 # See configuration.py for a list of all supported configuration parameters. configuration = client.Configuration( host = "http://localhost/api/v1" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure HTTP basic authorization: Basic configuration = client.Configuration( username = 'YOUR_USERNAME', password = 'YOUR_PASSWORD' ) # Enter a context with an instance of the API client with client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = connection_api.ConnectionApi(api_client) connection_id = "connection_id_example" # str | The connection ID. connection = Connection() # Connection | update_mask = [ "update_mask_example", ] # [str] | The fields to update on the resource. If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields. (optional) # example passing only required values which don't have defaults set try: # Update a connection api_response = api_instance.patch_connection(connection_id, connection) pprint(api_response) except client.ApiException as e: print("Exception when calling ConnectionApi->patch_connection: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: # Update a connection api_response = api_instance.patch_connection(connection_id, connection, update_mask=update_mask) pprint(api_response) except client.ApiException as e: print("Exception when calling ConnectionApi->patch_connection: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
connection_id | str | The connection ID. | |
connection | Connection | ||
update_mask | [str] | The fields to update on the resource. If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields. | [optional] |
Status code | Description | Response headers |
---|---|---|
200 | Success. | - |
400 | Client specified an invalid argument. | - |
401 | Request not authenticated due to missing, invalid, authentication info. | - |
403 | Client does not have sufficient permission. | - |
404 | A specified resource is not found. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Connection post_connection(connection)
Create a connection
import time import airflow_client.client from airflow_client.client.api import connection_api from airflow_client.client.model.connection import Connection from airflow_client.client.model.error import Error from pprint import pprint # Defining the host is optional and defaults to http://localhost/api/v1 # See configuration.py for a list of all supported configuration parameters. configuration = client.Configuration( host = "http://localhost/api/v1" ) # The client must configure the authentication and authorization parameters # in accordance with the API server security policy. # Examples for each auth method are provided below, use the example that # satisfies your auth use case. # Configure HTTP basic authorization: Basic configuration = client.Configuration( username = 'YOUR_USERNAME', password = 'YOUR_PASSWORD' ) # Enter a context with an instance of the API client with client.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = connection_api.ConnectionApi(api_client) connection = Connection() # Connection | # example passing only required values which don't have defaults set try: # Create a connection api_response = api_instance.post_connection(connection) pprint(api_response) except client.ApiException as e: print("Exception when calling ConnectionApi->post_connection: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
connection | Connection |
Status code | Description | Response headers |
---|---|---|
200 | Success. | - |
400 | Client specified an invalid argument. | - |
401 | Request not authenticated due to missing, invalid, authentication info. | - |
403 | Client does not have sufficient permission. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]