Get Started on Cloud
BasicsAI AgentsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAMLBuddy GitCLIAPIFAQ

YAML for distributions

View as Markdown

Learn how to configure routing distributions using YAML in Buddy. Map domains, subdomains and paths to tunnels, sandboxes, artifacts or external addresses, per region.

YAML parameters for YAML for distributions

Distribution
distributionrequiredstring
A human-readable ID of the distribution.
namestring
The name of the distribution
disabledboolean
Indicates if the distribution is disabled
permissionsPermissionsYaml
The permissions for the distribution
routesRouteYaml[]
The list of routes associated with the distribution

Last modified on Sep 8, 2026

Previous pageYAML for domains

YAML examples for YAML for distributions

Single route to an external backend

yaml
- distribution: my-distro
  routes:
    - domain: example.com
      target:
        endpoint: EXTERNAL
        address: https://backend.example.com

Distribution with permissions and all target types

yaml
- distribution: my-distro
  name: My Distribution
  disabled: false
  permissions:
    others: READ_ONLY
    users:
      dev@example.com: MANAGE
    groups:
      admins: MANAGE
  routes:
    - domain: example.com
      subdomain: www
      path: /api
      type: DIRECT_PROXY
      target:
        endpoint: EXTERNAL
        address: https://backend.example.com
    - domain: cdn.example.com
      type: CACHED_PROXY
      target:
        endpoint: SANDBOX
        sandbox:
          id: my-sandbox
          endpoint: web
    - domain: app.example.com
      target:
        endpoint: TUNNEL
        tunnel:
          agent: my-agent
          name: my-tunnel
    - domain: downloads.example.com
      target:
        endpoint: ARTIFACT
        artifact:
          id: my-artifact
          version: 1.0.0

Geolocation routing by region

yaml
- distribution: geo-distro
  routes:
    - domain: geo.example.com
      type: CLOAKING
      regions:
        Default:
          endpoint: EXTERNAL
          address: https://global.example.com
        Asia:
          endpoint: EXTERNAL
          address: https://asia.example.com
        US:
          endpoint: EXTERNAL
          address: https://us.example.com