Nest Engineering Docs
Interface

Configuration

Runtime configuration and environment variables for Interface

Settings file

  • services/interface/config/settings.py
  • Local overrides can be placed in services/interface/.env.

Environment variables

VariableRequiredDefaultPurpose
PROJECT_NAMENoNest Data Pipeline - Interface APIService display name
API_V1_STRNo/api/v1v1 API prefix
API_V2_STRNo/api/v2v2 API prefix
DEBUGNofalseEnables debug mode
SENTRY_ENVIRONMENTNoproductionSentry environment tag
ALLOWED_ORIGINSNo["*"]CORS allowlist
GCP_PROJECT_IDNoresolved via metadataGCP project id
SPANNER_INSTANCE_IDYesnoneSpanner instance id
SPANNER_DATABASE_IDYesnoneSpanner database id

Secrets (Secret Manager)

SecretRequiredPurpose
INTERFACE_API_KEYYesAPI key used by X-API-Key middleware
INTERFACE_SENTRY_DSNNoError and trace reporting

Last updated on