Paths

Configure path-based API routing in the Serverless API Gateway. Define methods, endpoints, auth, mappings, and server integrations per route.

The paths section is an array of objects where each object represents an API endpoint configuration.

• method: HTTP method (GET, POST, etc.).

• path: URL path of the API endpoint.

• integration: Server integration settings.

  • http and http_proxy are both accepted for HTTP proxy integrations.

• auth: Indicates if the path requires authentication.

• mapping: Defines mappings for headers and query parameters.

• variables: Sets variables used in the endpoint.

• response: Specifies the response structure for the endpoint.

See Also

• Add and Remove Prefix -- manipulate URL prefixes when proxying requests to upstream servers.

• Servers -- define the upstream servers referenced in path integration settings.

• Variable Mapping -- transform request headers and query parameters using dynamic templates.