Skip to main content

Interface: IEngineServerEnvironmentVariables

The engine server environment variables.

Properties​

port?​

optional port?: string

The port to serve the API from.

host?​

optional host?: string

The host to serve the API from.

corsOrigins?​

optional corsOrigins?: string

The CORS origins to allow, defaults to *.

httpMethods?​

optional httpMethods?: string

The CORS methods to allow, defaults to GET, POST, PUT, DELETE, OPTIONS.

httpAllowedHeaders?​

optional httpAllowedHeaders?: string

The CORS headers to allow.

httpExposedHeaders?​

optional httpExposedHeaders?: string

The CORS headers to expose.

httpBodyLimits?​

optional httpBodyLimits?: string

Named request body limits in bytes as comma separated name=bytes pairs, e.g. default=2097152,large=26214400.

publicOrigin?​

optional publicOrigin?: string

The public origin URL for the API e.g. https://api.example.com:1234

authAdminProcessorType?​

optional authAdminProcessorType?: string

The type of auth admin processor to use on the API: entity-storage.

authProcessorType?​

optional authProcessorType?: string

The type of auth processor to use on the API: entity-storage.

authSigningKeyId?​

optional authSigningKeyId?: string

The id of the key in the vault to use for signing in auth operations.

authApiKeyHeader?​

optional authApiKeyHeader?: string

The HTTP header name used to pass the API key on requests, defaults to x-api-key.

mimeTypeProcessors?​

optional mimeTypeProcessors?: string

Additional MIME type processors to include, comma separated.

routeLoggingIncludeBody?​

optional routeLoggingIncludeBody?: string

Include the body in the REST logging output, useful for debugging.

routeLoggingFullBase64?​

optional routeLoggingFullBase64?: string

Include the full base 64 output in the REST logging output, useful for debugging.

routeLoggingObfuscateProperties?​

optional routeLoggingObfuscateProperties?: string

List of properties to obfuscate in the REST logging output, comma separated.

routeMetricsExcludePaths?​

optional routeMetricsExcludePaths?: string

Comma-separated list of URL path prefixes excluded from metrics collection.

routeTracingExcludePaths?​

optional routeTracingExcludePaths?: string

Comma-separated list of URL path prefixes excluded from tracing.