Environment Variables
Variable Reference
Section titled “Variable Reference”| Variable | Required | Default | Description |
|---|---|---|---|
F5XC_API_URL | For auth | - | Tenant URL (auto-normalized) |
F5XC_API_TOKEN | Token auth | - | API token from XC Console |
F5XC_P12_BUNDLE | Cert auth | - | Absolute path to P12 certificate bundle |
F5XC_P12_PASSWORD | Cert auth | - | Password for P12 certificate |
F5XC_CERT | Cert auth | - | Absolute path to PEM certificate file |
F5XC_KEY | Cert auth | - | Absolute path to PEM private key file |
F5XC_PROFILE | No | Active profile | Profile name from ~/.config/f5xc/profiles/ |
F5XC_TLS_INSECURE | No | false | Disable SSL verification (staging only) |
F5XC_CA_BUNDLE | No | - | Path to custom CA certificate bundle |
F5XC_QUOTA_CHECK_ENABLED | No | true | Enable/disable quota validation |
F5XC_QUOTA_CACHE_TTL | No | 300 | Quota cache TTL in seconds |
F5XC_QUOTA_GREEN_THRESHOLD | No | 79 | Green zone upper bound (%) |
F5XC_QUOTA_YELLOW_THRESHOLD | No | 99 | Yellow zone upper bound (%) |
F5XC_QUOTA_RED_THRESHOLD | No | 100 | Red zone threshold (%) |
LOG_LEVEL | No | info | Logging level: debug, info, warn, error |
NODE_ENV | No | production | Node environment: development, production |
Authentication Variables
Section titled “Authentication Variables”F5XC_API_URL
Section titled “F5XC_API_URL”The F5 Distributed Cloud tenant URL. Multiple formats accepted and auto-normalized.
export F5XC_API_URL="https://your-tenant.console.ves.volterra.io"See URL Normalization for accepted formats.
F5XC_API_TOKEN
Section titled “F5XC_API_TOKEN”API token from F5XC Console. Required for token-based authentication.
export F5XC_API_TOKEN="your-api-token"F5XC_P12_BUNDLE
Section titled “F5XC_P12_BUNDLE”Absolute path to P12 certificate bundle. Required for P12-based certificate authentication.
export F5XC_P12_BUNDLE="/path/to/certificate.p12"F5XC_P12_PASSWORD
Section titled “F5XC_P12_PASSWORD”Password for the P12 certificate.
export F5XC_P12_PASSWORD="certificate-password"F5XC_CERT
Section titled “F5XC_CERT”Absolute path to PEM-formatted certificate file. Use with F5XC_KEY for PEM-based certificate authentication.
export F5XC_CERT="/path/to/certificate.pem"F5XC_KEY
Section titled “F5XC_KEY”Absolute path to PEM-formatted private key file. Required when using F5XC_CERT.
export F5XC_KEY="/path/to/private-key.pem"F5XC_PROFILE
Section titled “F5XC_PROFILE”Select a profile from ~/.config/f5xc/profiles/ for multi-tenant credential management.
export F5XC_PROFILE="staging"See Profile-Based Configuration for setup details.
SSL/TLS Variables
Section titled “SSL/TLS Variables”F5XC_TLS_INSECURE
Section titled “F5XC_TLS_INSECURE”Disable SSL certificate verification. Use only in development/staging environments.
export F5XC_TLS_INSECURE="true"F5XC_CA_BUNDLE
Section titled “F5XC_CA_BUNDLE”Path to a custom CA certificate bundle for SSL/TLS verification.
export F5XC_CA_BUNDLE="/path/to/ca-bundle.crt"See SSL/TLS Configuration for staging environment guidance.
Quota Variables
Section titled “Quota Variables”F5XC_QUOTA_CHECK_ENABLED
Section titled “F5XC_QUOTA_CHECK_ENABLED”Enable or disable pre-flight quota validation before resource creation.
export F5XC_QUOTA_CHECK_ENABLED="true"F5XC_QUOTA_CACHE_TTL
Section titled “F5XC_QUOTA_CACHE_TTL”Cache TTL in seconds for quota data. Default is 300 (5 minutes).
export F5XC_QUOTA_CACHE_TTL="300"F5XC_QUOTA_GREEN_THRESHOLD
Section titled “F5XC_QUOTA_GREEN_THRESHOLD”Percentage upper bound for the green zone (no warnings). Default is 79.
export F5XC_QUOTA_GREEN_THRESHOLD="79"F5XC_QUOTA_YELLOW_THRESHOLD
Section titled “F5XC_QUOTA_YELLOW_THRESHOLD”Percentage upper bound for the yellow zone (warning). Default is 99.
export F5XC_QUOTA_YELLOW_THRESHOLD="99"F5XC_QUOTA_RED_THRESHOLD
Section titled “F5XC_QUOTA_RED_THRESHOLD”Percentage threshold for the red zone (creation blocked). Default is 100.
export F5XC_QUOTA_RED_THRESHOLD="100"See Quota Awareness for threshold behavior details.
Configuration Variables
Section titled “Configuration Variables”LOG_LEVEL
Section titled “LOG_LEVEL”Controls logging verbosity. Logs go to stderr to avoid interfering with MCP protocol.
export LOG_LEVEL="info"| Level | Description |
|---|---|
debug | Verbose debugging information |
info | General operational information (default) |
warn | Warning messages |
error | Error messages only |
NODE_ENV
Section titled “NODE_ENV”Node.js environment setting.
export NODE_ENV="production"| Value | Behavior |
|---|---|
development | Additional debug output |
production | Optimized for production (default) |
Setting Variables
Section titled “Setting Variables”Shell (Temporary)
Section titled “Shell (Temporary)”export F5XC_API_URL="https://tenant.console.ves.volterra.io"export F5XC_API_TOKEN="your-token"npx @robinmordasiewicz/f5xc-api-mcpShell Profile (Persistent)
Section titled “Shell Profile (Persistent)”Add to ~/.zshrc, ~/.bashrc, or equivalent:
export F5XC_API_URL="https://tenant.console.ves.volterra.io"export F5XC_API_TOKEN="your-token".env File
Section titled “.env File”Create .env in your project:
F5XC_API_URL=https://tenant.console.ves.volterra.ioF5XC_API_TOKEN=your-tokenLOG_LEVEL=infoDocker
Section titled “Docker”Pass with -e flags:
docker run -it \ -e F5XC_API_URL="https://tenant.console.ves.volterra.io" \ -e F5XC_API_TOKEN="your-token" \ ghcr.io/robinmordasiewicz/f5xc-api-mcpOr with env file:
docker run -it --env-file .env ghcr.io/robinmordasiewicz/f5xc-api-mcpFor MCP JSON env blocks, see IDE Setup.
Credential Priority
Section titled “Credential Priority”Environment variables > active profile > documentation mode. See Authentication for details.
Validation
Section titled “Validation”Check Settings
Section titled “Check Settings”env | grep F5XCVerify in Server
Section titled “Verify in Server”Ask Claude:
“Get the F5XC API server info”
Check for authenticated: true and correct authMethod.
Next Steps
Section titled “Next Steps”- Authentication - Auth setup and profile configuration
- IDE Setup - MCP JSON configuration for all editors
- Advanced Features - Quota awareness, SSL/TLS, server defaults
- Troubleshooting - Common issues and solutions