Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/vercel/next.js/llms.txt

Use this file to discover all available pages before exploring further.

NextResponse extends the native Web Response API with additional convenience methods for use in Middleware and Route Handlers.

​
Static methods

​
NextResponse.json()

Creates a Response with a JSON body and sets the Content-Type header to application/json.
app/api/route.ts
import { NextResponse } from 'next/server'

export async function GET(request: Request) {
  return NextResponse.json({ error: 'Internal Server Error' }, { status: 500 })
}
​
body
any
required
The value to serialize as JSON.
​
init
ResponseInit
Optional response options: status, statusText, headers.

​
NextResponse.redirect()

Creates a response that redirects the user to a URL. 
import { NextResponse } from 'next/server'

return NextResponse.redirect(new URL('/new', request.url))
You can modify the URL before redirecting: 
import { NextResponse } from 'next/server'

const loginUrl = new URL('/login', request.url)
loginUrl.searchParams.set('from', request.nextUrl.pathname)
return NextResponse.redirect(loginUrl)
​
url
string | URL
required
The destination URL.
​
init
ResponseInit
Optional response options (e.g. { status: 308 } for permanent redirect).

​
NextResponse.rewrite()

Creates a response that rewrites (proxies) the request to a given URL while keeping the original URL in the browser address bar. 
import { NextResponse } from 'next/server'

// Browser shows /about, but content is served from /proxy
return NextResponse.rewrite(new URL('/proxy', request.url))
​
url
string | URL
required
The URL to proxy the request to.

​
NextResponse.next()

Continues to the next middleware or route handler without modifying the response. Useful in middleware when you want to pass through with optional header modifications. 
import { NextResponse } from 'next/server'

return NextResponse.next()
To forward modified request headers upstream (to the page/route handler, not to the client): 
import { NextResponse } from 'next/server'

const newHeaders = new Headers(request.headers)
newHeaders.set('x-version', '123')

return NextResponse.next({
  request: { headers: newHeaders },
})
Avoid using NextResponse.next({ headers }) (the shorthand form) to send response headers to the client — it can override framework expectations (e.g. Content-Type for Server Actions) and leak sensitive data. Use NextResponse.next({ request: { headers } }) to forward request headers upstream only.

​
cookies

Read or mutate the Set-Cookie header of the response.
​
get(name)
{ name: string; value: string } | undefined
Returns the first cookie with the given name.
response.cookies.get('show-banner')
​
getAll(name?)
{ name: string; value: string }[]
Returns all cookies with the given name, or all cookies if no name is provided.
response.cookies.getAll('experiments')
​
set(name, value)
void
Sets a cookie on the response.
response.cookies.set('show-banner', 'false')
​
has(name)
boolean
Returns true if the cookie exists on the response.
response.cookies.has('experiments')
​
delete(name)
boolean
Deletes the cookie from the response. Returns true if deleted.
response.cookies.delete('experiments')

​
Example: middleware with auth check

middleware.ts
import { type NextRequest, NextResponse } from 'next/server'

export function middleware(request: NextRequest) {
  const session = request.cookies.get('session')

  if (!session && request.nextUrl.pathname.startsWith('/dashboard')) {
    return NextResponse.redirect(new URL('/login', request.url))
  }

  const response = NextResponse.next()
  // Set a cookie on the response
  response.cookies.set('last-visited', request.nextUrl.pathname)
  return response
}