Service configuration reference

A service is configured like any standalone Vercel project, using the same build and runtime settings.

The service configuration object supports the following properties. Settings are optional unless indicated otherwise.

• root
• framework
• runtime
• entrypoint
• installCommand
• buildCommand
• devCommand
• ignoreCommand
• outputDirectory
• bindings
• functions
• headers
• redirects
• rewrites
• routes
• cleanUrls
• trailingSlash

Type: string

Required. The path to the service root, relative to vercel.json.

Type: string

The Framework slug for the service, for example, "nextjs", "fastapi", or "express". Vercel detects the framework automatically when framework is not set.

Type: string

The Runtime for the service. Vercel detects the runtime automatically when runtime is not set.

Type: string

The framework or runtime entrypoint, such as main:app for a Python ASGI app or a file path for Node.js.

Type: string

The install command override for the service.

Type: string

The build command override for the service.

Type: string

The development command override for the service.

Type: string

The build-skip command for the service.

Type: string

The output directory for the service.

Type: array

Caller-side bindings to other services. See Service bindings.

Type: object

Function configuration scoped to the service.

Type: array

Header rules scoped to the service.

Type: array

Redirect rules scoped to the service.

Type: array

Rewrite rules scoped to the service.

Type: array

Low-level route rules scoped to the service.

Type: boolean

cleanUrls behavior scoped to the service.

Type: boolean

trailingSlash behavior scoped to the service.

The routing and URL keys run only after a request enters the service. See Routing.