Source code for airflow.operators.http_operator

# -*- coding: utf-8 -*-
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

from airflow.exceptions import AirflowException
from airflow.hooks.http_hook import HttpHook
from airflow.models import BaseOperator
from airflow.utils.decorators import apply_defaults

[docs]class SimpleHttpOperator(BaseOperator): """ Calls an endpoint on an HTTP system to execute an action :param http_conn_id: The connection to run the operator against :type http_conn_id: str :param endpoint: The relative part of the full url. (templated) :type endpoint: str :param method: The HTTP method to use, default = "POST" :type method: str :param data: The data to pass. POST-data in POST/PUT and params in the URL for a GET request. (templated) :type data: For POST/PUT, depends on the content-type parameter, for GET a dictionary of key/value string pairs :param headers: The HTTP headers to be added to the GET request :type headers: a dictionary of string key/value pairs :param response_check: A check against the 'requests' response object. Returns True for 'pass' and False otherwise. :type response_check: A lambda or defined function. :param extra_options: Extra options for the 'requests' library, see the 'requests' documentation (options to modify timeout, ssl, etc.) :type extra_options: A dictionary of options, where key is string and value depends on the option that's being modified. :param xcom_push: Push the response to Xcom (default: False). If xcom_push is True, response of an HTTP request will also be pushed to an XCom. :type xcom_push: bool :param log_response: Log the response (default: False) :type log_response: bool """
[docs] template_fields = ['endpoint', 'data', 'headers', ]
[docs] template_ext = ()
[docs] ui_color = '#f4a460'
@apply_defaults def __init__(self, endpoint, method='POST', data=None, headers=None, response_check=None, extra_options=None, xcom_push=False, http_conn_id='http_default', log_response=False, *args, **kwargs): super(SimpleHttpOperator, self).__init__(*args, **kwargs) self.http_conn_id = http_conn_id self.method = method self.endpoint = endpoint self.headers = headers or {} = data or {} self.response_check = response_check self.extra_options = extra_options or {} self.xcom_push_flag = xcom_push self.log_response = log_response
[docs] def execute(self, context): http = HttpHook(self.method, http_conn_id=self.http_conn_id)"Calling HTTP method") response =,, self.headers, self.extra_options) if self.log_response: if self.response_check: if not self.response_check(response): raise AirflowException("Response check returned False.") if self.xcom_push_flag: return response.text