Api
Run the Unkey API server for validating and managing API keys
Command Syntax
Some flags are required for this command to work properly.
Flags
--http-port
HTTP port for the API server to listen on. Default: 7070
- Type: integer
- Default:
7070 - Environment:
UNKEY_HTTP_PORT
--color
Enable colored log output. Default: true
- Type: boolean
- Default:
true - Environment:
UNKEY_LOGS_COLOR
--test-mode
Enable test mode. WARNING: Potentially unsafe, may trust client inputs blindly. Default: false
- Type: boolean
- Default:
false - Environment:
UNKEY_TEST_MODE
--platform
Cloud platform identifier for this node. Used for logging and metrics.
- Type: string
- Environment:
UNKEY_PLATFORM
--image
Container image identifier. Used for logging and metrics.
- Type: string
- Environment:
UNKEY_IMAGE
--region
Geographic region identifier. Used for logging and routing. Default: unknown
- Type: string
- Default:
"unknown" - Environment:
AWS_REGION
--instance-id
Unique identifier for this instance. Auto-generated if not provided.
- Type: string
- Default:
"ins_65sRey" - Environment:
UNKEY_INSTANCE_ID
--database-primary (required)
MySQL connection string for primary database. Required for all deployments. Example: user:pass@host:3306/unkey?parseTime=true
- Type: string
- Environment:
UNKEY_DATABASE_PRIMARY
--database-replica
MySQL connection string for read-replica. Reduces load on primary database. Format same as database-primary.
- Type: string
- Environment:
UNKEY_DATABASE_REPLICA
--redis-url
Redis connection string for rate-limiting and distributed counters. Example: redis://localhost:6379
- Type: string
- Environment:
UNKEY_REDIS_URL
--clickhouse-url
ClickHouse connection string for analytics. Recommended for production. Example: clickhouse://user:pass@host:9000/unkey
- Type: string
- Environment:
UNKEY_CLICKHOUSE_URL
--otel
Enable OpenTelemetry tracing and metrics
- Type: boolean
- Default:
false - Environment:
UNKEY_OTEL
--otel-trace-sampling-rate
Sampling rate for OpenTelemetry traces (0.0-1.0). Only used when --otel is provided. Default: 0.25
- Type: float
- Default:
0.25 - Environment:
UNKEY_OTEL_TRACE_SAMPLING_RATE
--prometheus-port
Enable Prometheus /metrics endpoint on specified port. Set to 0 to disable.
- Type: integer
- Environment:
UNKEY_PROMETHEUS_PORT
--tls-cert-file
Path to TLS certificate file for HTTPS. Both cert and key must be provided to enable HTTPS.
- Type: string
- Environment:
UNKEY_TLS_CERT_FILE
--tls-key-file
Path to TLS key file for HTTPS. Both cert and key must be provided to enable HTTPS.
- Type: string
- Environment:
UNKEY_TLS_KEY_FILE
--vault-master-keys
Vault master keys for encryption
- Type: string[]
- Environment:
UNKEY_VAULT_MASTER_KEYS
--vault-s3-url
S3 Compatible Endpoint URL
- Type: string
- Environment:
UNKEY_VAULT_S3_URL
--vault-s3-bucket
S3 bucket name
- Type: string
- Environment:
UNKEY_VAULT_S3_BUCKET
--vault-s3-access-key-id
S3 access key ID
- Type: string
- Environment:
UNKEY_VAULT_S3_ACCESS_KEY_ID
--vault-s3-secret-access-key
S3 secret access key
- Type: string
- Environment:
UNKEY_VAULT_S3_SECRET_ACCESS_KEY
--chproxy-enabled
Enable ClickHouse proxy endpoints for high-throughput event collection
- Type: boolean
- Default:
false - Environment:
UNKEY_CHPROXY_ENABLED
--chproxy-auth-token
Authentication token for ClickHouse proxy endpoints. Required when proxy is enabled.
- Type: string
- Environment:
UNKEY_CHPROXY_AUTH_TOKEN