headers

headers is anasync function that allows you toread the HTTP incoming request headers from aServer Component.

import { headers }from'next/headers'exportdefaultasyncfunctionPage() {constheadersList=awaitheaders()constuserAgent=headersList.get('user-agent')}

Reference

Parameters

headers does not take any parameters.

Returns

headers returns aread-onlyWeb Headers object.

• Headers.entries(): Returns aniterator allowing to go through all key/value pairs contained in this object.
• Headers.forEach(): Executes a provided function once for each key/value pair in thisHeaders object.
• Headers.get(): Returns aString sequence of all the values of a header within aHeaders object with a given name.
• Headers.has(): Returns a boolean stating whether aHeaders object contains a certain header.
• Headers.keys(): Returns aniterator allowing you to go through all keys of the key/value pairs contained in this object.
• Headers.values(): Returns aniterator allowing you to go through all values of the key/value pairs contained in this object.

Good to know

• headers is anasynchronous function that returns a promise. You must useasync/await or React'suse function.
  • In version 14 and earlier,headers was a synchronous function. To help with backwards compatibility, you can still access it synchronously in Next.js 15, but this behavior will be deprecated in the future.
• Sinceheaders is read-only, you cannotset ordelete the outgoing request headers.
• headers is aDynamic API whose returned values cannot be known ahead of time. Using it in will opt a route intodynamic rendering.

Examples

Using the Authorization header

import { headers }from'next/headers'exportdefaultasyncfunctionPage() {constauthorization= (awaitheaders()).get('authorization')constres=awaitfetch('...', {    headers: { authorization },// Forward the authorization header  })constuser=awaitres.json()return <h1>{user.name}</h1>}

Version History