Examples

Learn how to configure ProxyConf through practical examples covering authentication, CORS, TLS, and more.

Available Examples

Quick Examples

Public API (No Authentication)

x-proxyconf:
  cluster: my-cluster
  url: https://api.example.com/public
  security:
    auth:
      downstream:
        disabled: {}

API Key Authentication

x-proxyconf:
  cluster: my-cluster
  url: https://api.example.com/secure
  security:
    auth:
      downstream:
        type: header
        name: x-api-key
        clients:
          my-client:
            - 5e884898da28047151d0e56f8dc62927  # MD5 hash

JWT Authentication

x-proxyconf:
  cluster: my-cluster
  url: https://api.example.com/jwt-secured
  security:
    auth:
      downstream:
        jwt:
          provider_config:
            issuer: https://auth.example.com
            audiences:
              - my-api
            remote_jwks:
              http_uri:
                uri: https://auth.example.com/.well-known/jwks.json

IP Allowlisting + Authentication

x-proxyconf:
  cluster: my-cluster
  url: https://api.example.com/internal
  security:
    allowed-source-ips:
      - 10.0.0.0/8
      - 192.168.0.0/16
    auth:
      downstream:
        type: header
        name: x-api-key
        clients:
          internal-service:
            - 098f6bcd4621d373cade4e832627b4f6

See Also

• OpenAPI Extension Reference - Complete configuration reference
• Downstream Authentication - Detailed auth configuration guide
• Upstream Authentication - Backend credential injection