How to get Custom HTTP header in Magento2 controller?

Question

I'm accessing my controller via postman tool (Postman)

I've passed custom header as shown in image and trying to access it in controller through this code:

$this->_response->getHeader('APP_ID');

but it returns no data. Please Help.

Answer 1

Finally, got the solution

$httpRequestObject = new \Zend_Controller_Request_Http();
$httpRequestObject->getHeader('APP_ID');

Thank you!

Answer 2

As long as your controller is a child of AbstractAction you can also access this data by request instance: $this->getRequest()->getHeader('APP_ID')

Answer 3

Remember that All caps HTTP headers with underscores dropped in Apache 2.4.

Nginx:

http://nginx.org/en/docs/http/ngx_http_core_module.html#underscores_in_headers

So we can try add other values. For example: AppId without underscores.

We could get the header with

\Magento\Framework\App\RequestInterface

\Magento\Framework\Webapi\Request

\Magento\Framework\HTTP\PhpEnvironment\Request