outline	2 3
title	Configuration Reference
titleTemplate	NpgsqlRest
description	Complete NpgsqlRest configuration reference. All settings for connections, authentication, caching, logging, and more.
head	meta name content keywords npgsqlrest configuration, api configuration reference, postgresql rest config, appsettings reference, npgsqlrest settings meta property content og:title NpgsqlRest Configuration Reference meta property content og:description Complete configuration reference for all NpgsqlRest settings and options. meta property content og:type article

Configuration Reference

Complete reference documentation for all NpgsqlRest configuration options.

For an introduction to how configuration works (sources, precedence, environment variables, command-line arguments), see the Configuration Guide.

::: tip Latest Default Configuration See the Latest Default Configuration for a complete reference of all default settings for version 3.21.0. :::

Reference Sections

Core Settings

• Top-Level Settings - Application identity, URLs, and startup message
• Config Section - Configuration file processing and environment variables
• NpgsqlRest Options - Core API generation settings (URL prefixes, naming conventions, request handling)
• Routine Options - PostgreSQL routine handling (language filtering, custom types)
• Connection - Database connection strings and settings
• Server - Kestrel web server and SSL/TLS configuration

Security

• Authentication - Cookie, Bearer Token, and JWT authentication
• External OAuth - Google, LinkedIn, GitHub, Microsoft, Facebook OAuth
• Passkey Authentication - WebAuthn passwordless authentication
• Authentication Options - Per-endpoint authentication configuration
• Claims Mapping - User context and parameters mapping
• Basic Auth Config - HTTP Basic Authentication configuration
• Validation - Parameter validation rules (NotNull, Required, Regex, etc.)
• Antiforgery - CSRF protection settings
• Data Protection - Key storage and encryption settings
• CORS - Cross-Origin Resource Sharing configuration
• Security Headers - HTTP security headers (CSP, X-Frame-Options, etc.)
• Forwarded Headers - Proxy header processing (X-Forwarded-For, etc.)

Features

• SQL File Source - REST API endpoints from SQL files
• Test Runner - SQL test runner (--test): discovery, test databases, setup/teardown, coverage
• Watch Mode - --watch: restart the server or re-run tests on SQL file, configuration, and database routine changes
• Proxy - Reverse proxy support for forwarding requests to upstream services
• OpenAPI - OpenAPI/Swagger documentation generation
• MCP - Model Context Protocol server — expose routines as MCP tools for AI agents
• HTTP Files - HTTP test file generation
• Code Generation - Client code generation (TypeScript, TanStack Query hooks)
• Dart Code Generation - Dart client code generation for Flutter projects
• Uploads - File upload handling
• Table Format - HTML table and Excel spreadsheet rendering for function results
• HTTP Client - HTTP Types for external API calls from PostgreSQL functions

Performance

• Response Compression - Gzip/Brotli compression settings
• Cache Options - Response caching configuration
• Rate Limiter - Rate limiting settings
• Command Retry - Database command retry policies
• Thread Pool - Thread pool configuration

Infrastructure

• Logging - Log levels and output configuration
• Static Files - Static file serving configuration
• Error Handling - Error response configuration
• Health Checks - Kubernetes probes and health check endpoints
• Stats - PostgreSQL statistics endpoints for monitoring