Custom HTTP Header in Django

Question

I use a custom http header for URL signature just called \"sign\", how to get such custom HTTP header value in Django?

Answer 1

Finally I found just get it through

request.META('HTTP_{your uppercased header name}')

Answer 2

You can add your own custom headers to a response like so: https://docs.djangoproject.com/en/dev/ref/request-response/#setting-headers

>>> response = HttpResponse()
>>> response['Cache-Control'] = 'no-cache'
>>> del response['Cache-Control']

Or use a decorator to add them to a view: http://djangosnippets.org/snippets/275/

Answer 3

Go ahead and use:

request.META.get('HTTP_{your uppercased header name}')

Note in Django you write the header name in capitals with underscores instead of dashes, but in the request on the client you must write it using dashes instead of underscores (production web servers will strip out custom headers with underscores in them for security reasons).

So, a custom header My-Custom-Header is accessed request.META['HTTP_MY_CUSTOM_HEADER']

Answer 4

From the Django documentation:

https://docs.djangoproject.com/en/2.1/ref/request-response/#django.http.HttpRequest.META

With the exception of CONTENT_LENGTH and CONTENT_TYPE, as given above, any HTTP headers in the request are converted to META keys by converting all characters to uppercase, replacing any hyphens with underscores and adding an HTTP_ prefix to the name. So, for example, a header called X-Bender would be mapped to the META key HTTP_X_BENDER.

Answer 5

I was trying to access the header with the above answers, using this code:

request.META.get('HTTP_{your uppercased header name}')

But It didn't work for me, and then I realized that the custom header should not contain underscore so I changed the underscore with dash and boom, everything started working. Hope this will help people like me. :-)

Answer 6

As of Django 2.2 you can use the HttpRequest.headers dictionary which provides case-insensitive dictionary of request headers, like such:

my_header = request.headers.get('x-my-custom-header')

See django.http.HttpRequest.headers