docs/VariableApi.md - airflow-client-python - Git at Google


            
            # airflow_client.client.VariableApi


            All URIs are relative to *http://localhost*


            Method | HTTP request | Description

            
            ------------- | ------------- | -------------

            
            [**bulk_variables**](VariableApi.md#bulk_variables) | **PATCH** /api/v2/variables | Bulk Variables

            
            [**delete_variable**](VariableApi.md#delete_variable) | **DELETE** /api/v2/variables/{variable_key} | Delete Variable

            
            [**get_variable**](VariableApi.md#get_variable) | **GET** /api/v2/variables/{variable_key} | Get Variable

            
            [**get_variables**](VariableApi.md#get_variables) | **GET** /api/v2/variables | Get Variables

            
            [**patch_variable**](VariableApi.md#patch_variable) | **PATCH** /api/v2/variables/{variable_key} | Patch Variable

            
            [**post_variable**](VariableApi.md#post_variable) | **POST** /api/v2/variables | Post Variable


            # **bulk_variables**

            
            > BulkResponse bulk_variables(bulk_body_variable_body)


            Bulk Variables


            Bulk create, update, and delete variables.


            ### Example


            * OAuth Authentication (OAuth2PasswordBearer):

            
            * Bearer Authentication (HTTPBearer):


            ```python

            
            import airflow_client.client

            
            from airflow_client.client.models.bulk_body_variable_body import BulkBodyVariableBody

            
            from airflow_client.client.models.bulk_response import BulkResponse

            
            from airflow_client.client.rest import ApiException

            
            from pprint import pprint


            # Defining the host is optional and defaults to http://localhost

            
            # See configuration.py for a list of all supported configuration parameters.

            
            configuration = airflow_client.client.Configuration(

            
                host = "http://localhost"

            
            )


            # 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.


            configuration.access_token = os.environ["ACCESS_TOKEN"]


            # Configure Bearer authorization: HTTPBearer

            
            configuration = airflow_client.client.Configuration(

            
                access_token = os.environ["BEARER_TOKEN"]

            
            )


            # Enter a context with an instance of the API client

            
            with airflow_client.client.ApiClient(configuration) as api_client:

            
                # Create an instance of the API class

            
                api_instance = airflow_client.client.VariableApi(api_client)

            
                bulk_body_variable_body = airflow_client.client.BulkBodyVariableBody() # BulkBodyVariableBody |


                try:

            
                    # Bulk Variables

            
                    api_response = api_instance.bulk_variables(bulk_body_variable_body)

            
                    print("The response of VariableApi->bulk_variables:\n")

            
                    pprint(api_response)

            
                except Exception as e:

            
                    print("Exception when calling VariableApi->bulk_variables: %s\n" % e)

            
            ```


            ### Parameters


            Name | Type | Description  | Notes

            
            ------------- | ------------- | ------------- | -------------

            
             **bulk_body_variable_body** | [**BulkBodyVariableBody**](BulkBodyVariableBody.md)|  |


            ### Return type


            [**BulkResponse**](BulkResponse.md)


            ### Authorization


            [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer)


            ### HTTP request headers


             - **Content-Type**: application/json

            
             - **Accept**: application/json


            ### HTTP response details


            | Status code | Description | Response headers |

            
            |-------------|-------------|------------------|

            
            **200** | Successful Response |  -  |

            
            **401** | Unauthorized |  -  |

            
            **403** | Forbidden |  -  |

            
            **422** | Validation Error |  -  |


            [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


            # **delete_variable**

            
            > delete_variable(variable_key)


            Delete Variable


            Delete a variable entry.


            ### Example


            * OAuth Authentication (OAuth2PasswordBearer):

            
            * Bearer Authentication (HTTPBearer):


            ```python

            
            import airflow_client.client

            
            from airflow_client.client.rest import ApiException

            
            from pprint import pprint


            # Defining the host is optional and defaults to http://localhost

            
            # See configuration.py for a list of all supported configuration parameters.

            
            configuration = airflow_client.client.Configuration(

            
                host = "http://localhost"

            
            )


            # 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.


            configuration.access_token = os.environ["ACCESS_TOKEN"]


            # Configure Bearer authorization: HTTPBearer

            
            configuration = airflow_client.client.Configuration(

            
                access_token = os.environ["BEARER_TOKEN"]

            
            )


            # Enter a context with an instance of the API client

            
            with airflow_client.client.ApiClient(configuration) as api_client:

            
                # Create an instance of the API class

            
                api_instance = airflow_client.client.VariableApi(api_client)

            
                variable_key = 'variable_key_example' # str |


                try:

            
                    # Delete Variable

            
                    api_instance.delete_variable(variable_key)

            
                except Exception as e:

            
                    print("Exception when calling VariableApi->delete_variable: %s\n" % e)

            
            ```


            ### Parameters


            Name | Type | Description  | Notes

            
            ------------- | ------------- | ------------- | -------------

            
             **variable_key** | **str**|  |


            ### Return type


            void (empty response body)


            ### Authorization


            [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer)


            ### HTTP request headers


             - **Content-Type**: Not defined

            
             - **Accept**: application/json


            ### HTTP response details


            | Status code | Description | Response headers |

            
            |-------------|-------------|------------------|

            
            **204** | Successful Response |  -  |

            
            **401** | Unauthorized |  -  |

            
            **403** | Forbidden |  -  |

            
            **404** | Not Found |  -  |

            
            **422** | Validation Error |  -  |


            [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


            # **get_variable**

            
            > VariableResponse get_variable(variable_key)


            Get Variable


            Get a variable entry.


            ### Example


            * OAuth Authentication (OAuth2PasswordBearer):

            
            * Bearer Authentication (HTTPBearer):


            ```python

            
            import airflow_client.client

            
            from airflow_client.client.models.variable_response import VariableResponse

            
            from airflow_client.client.rest import ApiException

            
            from pprint import pprint


            # Defining the host is optional and defaults to http://localhost

            
            # See configuration.py for a list of all supported configuration parameters.

            
            configuration = airflow_client.client.Configuration(

            
                host = "http://localhost"

            
            )


            # 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.


            configuration.access_token = os.environ["ACCESS_TOKEN"]


            # Configure Bearer authorization: HTTPBearer

            
            configuration = airflow_client.client.Configuration(

            
                access_token = os.environ["BEARER_TOKEN"]

            
            )


            # Enter a context with an instance of the API client

            
            with airflow_client.client.ApiClient(configuration) as api_client:

            
                # Create an instance of the API class

            
                api_instance = airflow_client.client.VariableApi(api_client)

            
                variable_key = 'variable_key_example' # str |


                try:

            
                    # Get Variable

            
                    api_response = api_instance.get_variable(variable_key)

            
                    print("The response of VariableApi->get_variable:\n")

            
                    pprint(api_response)

            
                except Exception as e:

            
                    print("Exception when calling VariableApi->get_variable: %s\n" % e)

            
            ```


            ### Parameters


            Name | Type | Description  | Notes

            
            ------------- | ------------- | ------------- | -------------

            
             **variable_key** | **str**|  |


            ### Return type


            [**VariableResponse**](VariableResponse.md)


            ### Authorization


            [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer)


            ### HTTP request headers


             - **Content-Type**: Not defined

            
             - **Accept**: application/json


            ### HTTP response details


            | Status code | Description | Response headers |

            
            |-------------|-------------|------------------|

            
            **200** | Successful Response |  -  |

            
            **401** | Unauthorized |  -  |

            
            **403** | Forbidden |  -  |

            
            **404** | Not Found |  -  |

            
            **422** | Validation Error |  -  |


            [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


            # **get_variables**

            
            > VariableCollectionResponse get_variables(limit=limit, offset=offset, order_by=order_by, variable_key_pattern=variable_key_pattern, variable_key_prefix_pattern=variable_key_prefix_pattern)


            Get Variables


            Get all Variables entries.


            ### Example


            * OAuth Authentication (OAuth2PasswordBearer):

            
            * Bearer Authentication (HTTPBearer):


            ```python

            
            import airflow_client.client

            
            from airflow_client.client.models.variable_collection_response import VariableCollectionResponse

            
            from airflow_client.client.rest import ApiException

            
            from pprint import pprint


            # Defining the host is optional and defaults to http://localhost

            
            # See configuration.py for a list of all supported configuration parameters.

            
            configuration = airflow_client.client.Configuration(

            
                host = "http://localhost"

            
            )


            # 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.


            configuration.access_token = os.environ["ACCESS_TOKEN"]


            # Configure Bearer authorization: HTTPBearer

            
            configuration = airflow_client.client.Configuration(

            
                access_token = os.environ["BEARER_TOKEN"]

            
            )


            # Enter a context with an instance of the API client

            
            with airflow_client.client.ApiClient(configuration) as api_client:

            
                # Create an instance of the API class

            
                api_instance = airflow_client.client.VariableApi(api_client)

            
                limit = 50 # int |  (optional) (default to 50)

            
                offset = 0 # int |  (optional) (default to 0)

            
                order_by = ["id"] # List[str] | Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, id, _val, description, is_encrypted, team_name` (optional) (default to ["id"])

            
                variable_key_pattern = 'variable_key_pattern_example' # str | Case-insensitive substring match (SQL `ILIKE`). Slower than `variable_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\". (optional)

            
                variable_key_prefix_pattern = 'variable_key_prefix_pattern_example' # str | Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\". (optional)


                try:

            
                    # Get Variables

            
                    api_response = api_instance.get_variables(limit=limit, offset=offset, order_by=order_by, variable_key_pattern=variable_key_pattern, variable_key_prefix_pattern=variable_key_prefix_pattern)

            
                    print("The response of VariableApi->get_variables:\n")

            
                    pprint(api_response)

            
                except Exception as e:

            
                    print("Exception when calling VariableApi->get_variables: %s\n" % e)

            
            ```


            ### Parameters


            Name | Type | Description  | Notes

            
            ------------- | ------------- | ------------- | -------------

            
             **limit** | **int**|  | [optional] [default to 50]

            
             **offset** | **int**|  | [optional] [default to 0]

            
             **order_by** | [**List[str]**](str.md)| Attributes to order by, multi criteria sort is supported. Prefix with &#x60;-&#x60; for descending order. Supported attributes: &#x60;key, id, _val, description, is_encrypted, team_name&#x60; | [optional] [default to [&quot;id&quot;]]

            
             **variable_key_pattern** | **str**| Case-insensitive substring match (SQL &#x60;ILIKE&#x60;). Slower than &#x60;variable_key_prefix_pattern&#x60; on large tables — see \&quot;Filtering with pattern parameters\&quot;. | [optional]

            
             **variable_key_prefix_pattern** | **str**| Case-sensitive, index-friendly prefix match. See \&quot;Filtering with pattern parameters\&quot;. | [optional]


            ### Return type


            [**VariableCollectionResponse**](VariableCollectionResponse.md)


            ### Authorization


            [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer)


            ### HTTP request headers


             - **Content-Type**: Not defined

            
             - **Accept**: application/json


            ### HTTP response details


            | Status code | Description | Response headers |

            
            |-------------|-------------|------------------|

            
            **200** | Successful Response |  -  |

            
            **401** | Unauthorized |  -  |

            
            **403** | Forbidden |  -  |

            
            **422** | Validation Error |  -  |


            [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


            # **patch_variable**

            
            > VariableResponse patch_variable(variable_key, variable_body, update_mask=update_mask)


            Patch Variable


            Update a variable by key.


            ### Example


            * OAuth Authentication (OAuth2PasswordBearer):

            
            * Bearer Authentication (HTTPBearer):


            ```python

            
            import airflow_client.client

            
            from airflow_client.client.models.variable_body import VariableBody

            
            from airflow_client.client.models.variable_response import VariableResponse

            
            from airflow_client.client.rest import ApiException

            
            from pprint import pprint


            # Defining the host is optional and defaults to http://localhost

            
            # See configuration.py for a list of all supported configuration parameters.

            
            configuration = airflow_client.client.Configuration(

            
                host = "http://localhost"

            
            )


            # 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.


            configuration.access_token = os.environ["ACCESS_TOKEN"]


            # Configure Bearer authorization: HTTPBearer

            
            configuration = airflow_client.client.Configuration(

            
                access_token = os.environ["BEARER_TOKEN"]

            
            )


            # Enter a context with an instance of the API client

            
            with airflow_client.client.ApiClient(configuration) as api_client:

            
                # Create an instance of the API class

            
                api_instance = airflow_client.client.VariableApi(api_client)

            
                variable_key = 'variable_key_example' # str |

            
                variable_body = airflow_client.client.VariableBody() # VariableBody |

            
                update_mask = ['update_mask_example'] # List[str] |  (optional)


                try:

            
                    # Patch Variable

            
                    api_response = api_instance.patch_variable(variable_key, variable_body, update_mask=update_mask)

            
                    print("The response of VariableApi->patch_variable:\n")

            
                    pprint(api_response)

            
                except Exception as e:

            
                    print("Exception when calling VariableApi->patch_variable: %s\n" % e)

            
            ```


            ### Parameters


            Name | Type | Description  | Notes

            
            ------------- | ------------- | ------------- | -------------

            
             **variable_key** | **str**|  |

            
             **variable_body** | [**VariableBody**](VariableBody.md)|  |

            
             **update_mask** | [**List[str]**](str.md)|  | [optional]


            ### Return type


            [**VariableResponse**](VariableResponse.md)


            ### Authorization


            [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer)


            ### HTTP request headers


             - **Content-Type**: application/json

            
             - **Accept**: application/json


            ### HTTP response details


            | Status code | Description | Response headers |

            
            |-------------|-------------|------------------|

            
            **200** | Successful Response |  -  |

            
            **400** | Bad Request |  -  |

            
            **401** | Unauthorized |  -  |

            
            **403** | Forbidden |  -  |

            
            **404** | Not Found |  -  |

            
            **422** | Validation Error |  -  |


            [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


            # **post_variable**

            
            > VariableResponse post_variable(variable_body)


            Post Variable


            Create a variable.


            ### Example


            * OAuth Authentication (OAuth2PasswordBearer):

            
            * Bearer Authentication (HTTPBearer):


            ```python

            
            import airflow_client.client

            
            from airflow_client.client.models.variable_body import VariableBody

            
            from airflow_client.client.models.variable_response import VariableResponse

            
            from airflow_client.client.rest import ApiException

            
            from pprint import pprint


            # Defining the host is optional and defaults to http://localhost

            
            # See configuration.py for a list of all supported configuration parameters.

            
            configuration = airflow_client.client.Configuration(

            
                host = "http://localhost"

            
            )


            # 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.


            configuration.access_token = os.environ["ACCESS_TOKEN"]


            # Configure Bearer authorization: HTTPBearer

            
            configuration = airflow_client.client.Configuration(

            
                access_token = os.environ["BEARER_TOKEN"]

            
            )


            # Enter a context with an instance of the API client

            
            with airflow_client.client.ApiClient(configuration) as api_client:

            
                # Create an instance of the API class

            
                api_instance = airflow_client.client.VariableApi(api_client)

            
                variable_body = airflow_client.client.VariableBody() # VariableBody |


                try:

            
                    # Post Variable

            
                    api_response = api_instance.post_variable(variable_body)

            
                    print("The response of VariableApi->post_variable:\n")

            
                    pprint(api_response)

            
                except Exception as e:

            
                    print("Exception when calling VariableApi->post_variable: %s\n" % e)

            
            ```


            ### Parameters


            Name | Type | Description  | Notes

            
            ------------- | ------------- | ------------- | -------------

            
             **variable_body** | [**VariableBody**](VariableBody.md)|  |


            ### Return type


            [**VariableResponse**](VariableResponse.md)


            ### Authorization


            [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer)


            ### HTTP request headers


             - **Content-Type**: application/json

            
             - **Accept**: application/json


            ### HTTP response details


            | Status code | Description | Response headers |

            
            |-------------|-------------|------------------|

            
            **201** | Successful Response |  -  |

            
            **401** | Unauthorized |  -  |

            
            **403** | Forbidden |  -  |

            
            **409** | Conflict |  -  |

            
            **422** | Validation Error |  -  |


            [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
	# airflow_client.client.VariableApi

	All URIs are relative to http://localhost

	Method \| HTTP request \| Description
	------------- \| ------------- \| -------------
	[bulk_variables](VariableApi.md#bulk_variables) \| PATCH /api/v2/variables \| Bulk Variables
	[delete_variable](VariableApi.md#delete_variable) \| DELETE /api/v2/variables/{variable_key} \| Delete Variable
	[get_variable](VariableApi.md#get_variable) \| GET /api/v2/variables/{variable_key} \| Get Variable
	[get_variables](VariableApi.md#get_variables) \| GET /api/v2/variables \| Get Variables
	[patch_variable](VariableApi.md#patch_variable) \| PATCH /api/v2/variables/{variable_key} \| Patch Variable
	[post_variable](VariableApi.md#post_variable) \| POST /api/v2/variables \| Post Variable


	# bulk_variables
	> BulkResponse bulk_variables(bulk_body_variable_body)

	Bulk Variables

	Bulk create, update, and delete variables.

	### Example

	* OAuth Authentication (OAuth2PasswordBearer):
	* Bearer Authentication (HTTPBearer):

	```python
	import airflow_client.client
	from airflow_client.client.models.bulk_body_variable_body import BulkBodyVariableBody
	from airflow_client.client.models.bulk_response import BulkResponse
	from airflow_client.client.rest import ApiException
	from pprint import pprint

	# Defining the host is optional and defaults to http://localhost
	# See configuration.py for a list of all supported configuration parameters.
	configuration = airflow_client.client.Configuration(
	host = "http://localhost"
	)

	# 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.

	configuration.access_token = os.environ["ACCESS_TOKEN"]

	# Configure Bearer authorization: HTTPBearer
	configuration = airflow_client.client.Configuration(
	access_token = os.environ["BEARER_TOKEN"]
	)

	# Enter a context with an instance of the API client
	with airflow_client.client.ApiClient(configuration) as api_client:
	# Create an instance of the API class
	api_instance = airflow_client.client.VariableApi(api_client)
	bulk_body_variable_body = airflow_client.client.BulkBodyVariableBody() # BulkBodyVariableBody \|

	try:
	# Bulk Variables
	api_response = api_instance.bulk_variables(bulk_body_variable_body)
	print("The response of VariableApi->bulk_variables:\n")
	pprint(api_response)
	except Exception as e:
	print("Exception when calling VariableApi->bulk_variables: %s\n" % e)
	```



	### Parameters


	Name \| Type \| Description \| Notes
	------------- \| ------------- \| ------------- \| -------------
	bulk_body_variable_body \| [BulkBodyVariableBody](BulkBodyVariableBody.md)\| \|

	### Return type

	[BulkResponse](BulkResponse.md)

	### Authorization

	[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer)

	### HTTP request headers

	- Content-Type: application/json
	- Accept: application/json

	### HTTP response details

	\| Status code \| Description \| Response headers \|
	\|-------------\|-------------\|------------------\|
	200 \| Successful Response \| - \|
	401 \| Unauthorized \| - \|
	403 \| Forbidden \| - \|
	422 \| Validation Error \| - \|

	[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

	# delete_variable
	> delete_variable(variable_key)

	Delete Variable

	Delete a variable entry.

	### Example

	* OAuth Authentication (OAuth2PasswordBearer):
	* Bearer Authentication (HTTPBearer):

	```python
	import airflow_client.client
	from airflow_client.client.rest import ApiException
	from pprint import pprint

	# Defining the host is optional and defaults to http://localhost
	# See configuration.py for a list of all supported configuration parameters.
	configuration = airflow_client.client.Configuration(
	host = "http://localhost"
	)

	# 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.

	configuration.access_token = os.environ["ACCESS_TOKEN"]

	# Configure Bearer authorization: HTTPBearer
	configuration = airflow_client.client.Configuration(
	access_token = os.environ["BEARER_TOKEN"]
	)

	# Enter a context with an instance of the API client
	with airflow_client.client.ApiClient(configuration) as api_client:
	# Create an instance of the API class
	api_instance = airflow_client.client.VariableApi(api_client)
	variable_key = 'variable_key_example' # str \|

	try:
	# Delete Variable
	api_instance.delete_variable(variable_key)
	except Exception as e:
	print("Exception when calling VariableApi->delete_variable: %s\n" % e)
	```



	### Parameters


	Name \| Type \| Description \| Notes
	------------- \| ------------- \| ------------- \| -------------
	variable_key \| str\| \|

	### Return type

	void (empty response body)

	### Authorization

	[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer)

	### HTTP request headers

	- Content-Type: Not defined
	- Accept: application/json

	### HTTP response details

	\| Status code \| Description \| Response headers \|
	\|-------------\|-------------\|------------------\|
	204 \| Successful Response \| - \|
	401 \| Unauthorized \| - \|
	403 \| Forbidden \| - \|
	404 \| Not Found \| - \|
	422 \| Validation Error \| - \|

	[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

	# get_variable
	> VariableResponse get_variable(variable_key)

	Get Variable

	Get a variable entry.

	### Example

	* OAuth Authentication (OAuth2PasswordBearer):
	* Bearer Authentication (HTTPBearer):

	```python
	import airflow_client.client
	from airflow_client.client.models.variable_response import VariableResponse
	from airflow_client.client.rest import ApiException
	from pprint import pprint

	# Defining the host is optional and defaults to http://localhost
	# See configuration.py for a list of all supported configuration parameters.
	configuration = airflow_client.client.Configuration(
	host = "http://localhost"
	)

	# 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.

	configuration.access_token = os.environ["ACCESS_TOKEN"]

	# Configure Bearer authorization: HTTPBearer
	configuration = airflow_client.client.Configuration(
	access_token = os.environ["BEARER_TOKEN"]
	)

	# Enter a context with an instance of the API client
	with airflow_client.client.ApiClient(configuration) as api_client:
	# Create an instance of the API class
	api_instance = airflow_client.client.VariableApi(api_client)
	variable_key = 'variable_key_example' # str \|

	try:
	# Get Variable
	api_response = api_instance.get_variable(variable_key)
	print("The response of VariableApi->get_variable:\n")
	pprint(api_response)
	except Exception as e:
	print("Exception when calling VariableApi->get_variable: %s\n" % e)
	```



	### Parameters


	Name \| Type \| Description \| Notes
	------------- \| ------------- \| ------------- \| -------------
	variable_key \| str\| \|

	### Return type

	[VariableResponse](VariableResponse.md)

	### Authorization

	[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer)

	### HTTP request headers

	- Content-Type: Not defined
	- Accept: application/json

	### HTTP response details

	\| Status code \| Description \| Response headers \|
	\|-------------\|-------------\|------------------\|
	200 \| Successful Response \| - \|
	401 \| Unauthorized \| - \|
	403 \| Forbidden \| - \|
	404 \| Not Found \| - \|
	422 \| Validation Error \| - \|

	[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

	# get_variables
	> VariableCollectionResponse get_variables(limit=limit, offset=offset, order_by=order_by, variable_key_pattern=variable_key_pattern, variable_key_prefix_pattern=variable_key_prefix_pattern)

	Get Variables

	Get all Variables entries.

	### Example

	* OAuth Authentication (OAuth2PasswordBearer):
	* Bearer Authentication (HTTPBearer):

	```python
	import airflow_client.client
	from airflow_client.client.models.variable_collection_response import VariableCollectionResponse
	from airflow_client.client.rest import ApiException
	from pprint import pprint

	# Defining the host is optional and defaults to http://localhost
	# See configuration.py for a list of all supported configuration parameters.
	configuration = airflow_client.client.Configuration(
	host = "http://localhost"
	)

	# 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.

	configuration.access_token = os.environ["ACCESS_TOKEN"]

	# Configure Bearer authorization: HTTPBearer
	configuration = airflow_client.client.Configuration(
	access_token = os.environ["BEARER_TOKEN"]
	)

	# Enter a context with an instance of the API client
	with airflow_client.client.ApiClient(configuration) as api_client:
	# Create an instance of the API class
	api_instance = airflow_client.client.VariableApi(api_client)
	limit = 50 # int \| (optional) (default to 50)
	offset = 0 # int \| (optional) (default to 0)
	order_by = ["id"] # List[str] \| Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, id, _val, description, is_encrypted, team_name` (optional) (default to ["id"])
	variable_key_pattern = 'variable_key_pattern_example' # str \| Case-insensitive substring match (SQL `ILIKE`). Slower than `variable_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\". (optional)
	variable_key_prefix_pattern = 'variable_key_prefix_pattern_example' # str \| Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\". (optional)

	try:
	# Get Variables
	api_response = api_instance.get_variables(limit=limit, offset=offset, order_by=order_by, variable_key_pattern=variable_key_pattern, variable_key_prefix_pattern=variable_key_prefix_pattern)
	print("The response of VariableApi->get_variables:\n")
	pprint(api_response)
	except Exception as e:
	print("Exception when calling VariableApi->get_variables: %s\n" % e)
	```



	### Parameters


	Name \| Type \| Description \| Notes
	------------- \| ------------- \| ------------- \| -------------
	limit \| int\| \| [optional] [default to 50]
	offset \| int\| \| [optional] [default to 0]
	order_by \| [List[str]](str.md)\| Attributes to order by, multi criteria sort is supported. Prefix with `-` for descending order. Supported attributes: `key, id, _val, description, is_encrypted, team_name` \| [optional] [default to ["id"]]
	variable_key_pattern \| str\| Case-insensitive substring match (SQL `ILIKE`). Slower than `variable_key_prefix_pattern` on large tables — see \"Filtering with pattern parameters\". \| [optional]
	variable_key_prefix_pattern \| str\| Case-sensitive, index-friendly prefix match. See \"Filtering with pattern parameters\". \| [optional]

	### Return type

	[VariableCollectionResponse](VariableCollectionResponse.md)

	### Authorization

	[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer)

	### HTTP request headers

	- Content-Type: Not defined
	- Accept: application/json

	### HTTP response details

	\| Status code \| Description \| Response headers \|
	\|-------------\|-------------\|------------------\|
	200 \| Successful Response \| - \|
	401 \| Unauthorized \| - \|
	403 \| Forbidden \| - \|
	422 \| Validation Error \| - \|

	[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

	# patch_variable
	> VariableResponse patch_variable(variable_key, variable_body, update_mask=update_mask)

	Patch Variable

	Update a variable by key.

	### Example

	* OAuth Authentication (OAuth2PasswordBearer):
	* Bearer Authentication (HTTPBearer):

	```python
	import airflow_client.client
	from airflow_client.client.models.variable_body import VariableBody
	from airflow_client.client.models.variable_response import VariableResponse
	from airflow_client.client.rest import ApiException
	from pprint import pprint

	# Defining the host is optional and defaults to http://localhost
	# See configuration.py for a list of all supported configuration parameters.
	configuration = airflow_client.client.Configuration(
	host = "http://localhost"
	)

	# 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.

	configuration.access_token = os.environ["ACCESS_TOKEN"]

	# Configure Bearer authorization: HTTPBearer
	configuration = airflow_client.client.Configuration(
	access_token = os.environ["BEARER_TOKEN"]
	)

	# Enter a context with an instance of the API client
	with airflow_client.client.ApiClient(configuration) as api_client:
	# Create an instance of the API class
	api_instance = airflow_client.client.VariableApi(api_client)
	variable_key = 'variable_key_example' # str \|
	variable_body = airflow_client.client.VariableBody() # VariableBody \|
	update_mask = ['update_mask_example'] # List[str] \| (optional)

	try:
	# Patch Variable
	api_response = api_instance.patch_variable(variable_key, variable_body, update_mask=update_mask)
	print("The response of VariableApi->patch_variable:\n")
	pprint(api_response)
	except Exception as e:
	print("Exception when calling VariableApi->patch_variable: %s\n" % e)
	```



	### Parameters


	Name \| Type \| Description \| Notes
	------------- \| ------------- \| ------------- \| -------------
	variable_key \| str\| \|
	variable_body \| [VariableBody](VariableBody.md)\| \|
	update_mask \| [List[str]](str.md)\| \| [optional]

	### Return type

	[VariableResponse](VariableResponse.md)

	### Authorization

	[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer)

	### HTTP request headers

	- Content-Type: application/json
	- Accept: application/json

	### HTTP response details

	\| Status code \| Description \| Response headers \|
	\|-------------\|-------------\|------------------\|
	200 \| Successful Response \| - \|
	400 \| Bad Request \| - \|
	401 \| Unauthorized \| - \|
	403 \| Forbidden \| - \|
	404 \| Not Found \| - \|
	422 \| Validation Error \| - \|

	[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

	# post_variable
	> VariableResponse post_variable(variable_body)

	Post Variable

	Create a variable.

	### Example

	* OAuth Authentication (OAuth2PasswordBearer):
	* Bearer Authentication (HTTPBearer):

	```python
	import airflow_client.client
	from airflow_client.client.models.variable_body import VariableBody
	from airflow_client.client.models.variable_response import VariableResponse
	from airflow_client.client.rest import ApiException
	from pprint import pprint

	# Defining the host is optional and defaults to http://localhost
	# See configuration.py for a list of all supported configuration parameters.
	configuration = airflow_client.client.Configuration(
	host = "http://localhost"
	)

	# 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.

	configuration.access_token = os.environ["ACCESS_TOKEN"]

	# Configure Bearer authorization: HTTPBearer
	configuration = airflow_client.client.Configuration(
	access_token = os.environ["BEARER_TOKEN"]
	)

	# Enter a context with an instance of the API client
	with airflow_client.client.ApiClient(configuration) as api_client:
	# Create an instance of the API class
	api_instance = airflow_client.client.VariableApi(api_client)
	variable_body = airflow_client.client.VariableBody() # VariableBody \|

	try:
	# Post Variable
	api_response = api_instance.post_variable(variable_body)
	print("The response of VariableApi->post_variable:\n")
	pprint(api_response)
	except Exception as e:
	print("Exception when calling VariableApi->post_variable: %s\n" % e)
	```



	### Parameters


	Name \| Type \| Description \| Notes
	------------- \| ------------- \| ------------- \| -------------
	variable_body \| [VariableBody](VariableBody.md)\| \|

	### Return type

	[VariableResponse](VariableResponse.md)

	### Authorization

	[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer), [HTTPBearer](../README.md#HTTPBearer)

	### HTTP request headers

	- Content-Type: application/json
	- Accept: application/json

	### HTTP response details

	\| Status code \| Description \| Response headers \|
	\|-------------\|-------------\|------------------\|
	201 \| Successful Response \| - \|
	401 \| Unauthorized \| - \|
	403 \| Forbidden \| - \|
	409 \| Conflict \| - \|
	422 \| Validation Error \| - \|

	[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)