48

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

6 Answers 6

86

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']

Sign up to request clarification or add additional context in comments.

Comments

17

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/

Comments

17

Finally I found just get it through

request.META.get('HTTP_YOUR_CUSTOM_HEADER') # hyphens are converted to underscores and the header is prefixed with HTTP_.

2 Comments

Thanks for the helpful pointer. Besides uppercasing the header name, I had to replace dashes with underscores. So, header name "My-custom-header" is request.META['HTTP_MY_CUSTOM_HEADER']
This code gives the following error TypeError: 'dict' object is not callable. Calling request.META.get('HTTP_{your uppercased header name}') is the correct way.
8

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. :-)

1 Comment

It's not my case but I believe your comment is useful.
7

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

1 Comment

How would you set the header this way?
3

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.

Comments

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.