HttpSensor

HTTP

Executes a HTTP GET statement and returns False on failure caused by 404 Not Found or response_check returning False.

View Source

Last Updated: Apr. 16, 2021

Access Instructions

Install the HTTP provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.

Parameters

http_conn_idstrThe connection to run the sensor against
methodstrThe HTTP request method to use
endpointstrThe relative part of the full url
request_paramsa dictionary of string key/value pairsThe parameters to be added to the GET url
headersa dictionary of string key/value pairsThe HTTP headers to be added to the GET request
response_checkA lambda or defined function.A check against the 'requests' response object. The callable takes the response object as the first positional argument and optionally any number of keyword arguments available in the context dictionary. It should return True for 'pass' and False otherwise.
extra_optionsA dictionary of options, where key is string and value depends on the option that's being modified.Extra options for the 'requests' library, see the 'requests' documentation (options to modify timeout, ssl, etc.)

Documentation

Executes a HTTP GET statement and returns False on failure caused by 404 Not Found or response_check returning False.

HTTP Error codes other than 404 (like 403) or Connection Refused Error would raise an exception and fail the sensor itself directly (no more poking). To avoid failing the task for other codes than 404, the argument extra_option can be passed with the value {'check_response': False}. It will make the response_check be execute for any http status code.

The response check can access the template context to the operator:

def response_check(response, task_instance):

# The task_instance is injected, so you can pull data form xcom # Other context variables such as dag, ds, execution_date are also available. xcom_data = task_instance.xcom_pull(task_ids=’pushing_task’) # In practice you would do something more sensible with this data.. print(xcom_data) return True

HttpSensor(task_id=’my_http_sensor’, …, response_check=response_check)

See also

For more information on how to use this operator, take a look at the guide: HttpSensor

Was this page helpful?