Services
Services let you deploy multiple backends and frontends within a single Vercel project. For example, a Next.js frontend and a FastAPI backend in the same repository deploy together with shared routing, environment variables, and a unique domain, replacing the need to split monorepos into separate Vercel projects.
Looking for the earlier experimentalServices configuration? See
Experimental Services. The services model
described here replaces it for new projects.
A service is an independently built unit within your project.
At build time, Vercel builds each service separately. At request time, Vercel routes incoming requests to the correct service based on the rewrite rules in your vercel.json.
A project can contain multiple services across different frameworks or runtimes, such as:
- A Next.js frontend at
/ - A Python FastAPI backend, e.g. at
/backend - A Go server, e.g. at
/svc/go
All services share the same deployment.
Services are valuable when you have:
- A polyglot monorepo: For example, a JavaScript frontend and a Python backend in the same repository that you want to deploy as one project.
- Multiple backends: Several API services, each with its own dependencies and build step.
Define services in vercel.json using the services key. A service is internal by default and will not be routable from the Internet unless you expose it.
To route a service publicly, include a top-level rewrite rule that targets the service as destination:
{
"services": {
"my_frontend": {
"root": "frontend/"
},
"my_backend": {
"root": "backend/",
"entrypoint": "main:app"
}
},
"rewrites": [
{ "source": "/api/(.*)", "destination": { "service": "my_backend" } },
{ "source": "/(.*)", "destination": { "service": "my_frontend" } }
]
}The two top-level rewrites are what expose these services. Without them, neither my_frontend nor my_backend would receive any public traffic. With the rewrites in place:
- Any request under
/api/, such as/api/users, routes tomy_backend. - Every other path routes to
my_frontend.
For the smallest possible setup, a single service with a catch-all rewrite:
{
"services": { "api": { "root": "api/" } },
"rewrites": [ { "source": "/(.*)", "destination": { "service": "api" } } ]
}Because every public request enters through the top-level route table, your deployment has one public surface. Firewall, Deployment Protection, redirects are configured once at the top level and apply across all services, instead of being redefined per service.
Read Service Routing to learn more about service public routing configuration.
A service can call another service directly over an internal binding, without going through the public internet. The calling service declares the binding, and Vercel injects the target service's URL as an environment variable for your server-side code to use.
Bindings are how services communicate privately. The target stays unreachable from the internet unless a separate top-level rewrite exposes it, so a binding grants internal access without creating a public route. See Service bindings to declare and use them.
Vercel builds each service according to the specified (or
auto-detected) runtime and framework settings. If you prefer or require
the service package to be built as a container (Docker) image instead, set
the runtime setting for the service to container.
{
"services": {
"frontend": {
"runtime": "container",
"root": "frontend/"
},
"backend": {
"runtime": "container",
"root": "backend/"
}
}
}See Container Images for more information about using container images with Vercel.
When a project does not define services, Vercel evaluates vercel.json normally. When services is present, the top-level keys split into two groups:
- Public routing and URL behavior stay at the top level, where they own public traffic for the whole deployment. See Routing.
- Build and runtime fields are not valid at the top level, because their owner would be ambiguous across services.
functions,installCommand,buildCommand,devCommand,ignoreCommand,outputDirectoryandframeworkkeys should be moved into the relevant service.
See Service configuration reference for all configuration options that can be set in a service configuration object.
Run all your services together locally with vercel dev:
vercel devTo run everything locally without authenticating with the Vercel Cloud, add the -L flag (short for --local):
vercel dev -LIn both cases, generated binding environment variables are injected automatically, so calls between services work the same locally as in production.
- Routing: How public requests reach services and how to control the path your code sees.
- Service bindings: How one service calls another.
- Pricing and Limits: How billing works for services and which limits apply.
- Queues with services: How a service consumes queue messages.
- Experimental Services: The earlier
experimentalServicesconfiguration model.
Was this helpful?