bdy distro route update

View as Markdown

$bdy distro route update|edit [options] <identifier> <route-id>

Update a route Required scopes: DISTRIBUTION_WRITE

ARGUMENTS

identifier

Human-readable ID of the distribution (required)

route-id

ID of the route (find via "bdy distro route ls") (required)

OPTIONS

--context <name>

Connection and scope context: default, git, link or a saved name. Overrides the globally active context for this invocation.

--examples

Show only examples; with this flag --format accepts text, json or jsonl

--verbose

Show REST API requests, responses, timing and retries on stderr

-w, --workspace <domain>

Workspace URL handle. Can be set via variable: BUDDY_WORKSPACE

--scope <scope>

Force scope (WORKSPACE, PROJECT). By default calculated by provided options and environmental variables (--project, BUDDY_PROJECT, linked project)

-p, --project <name>

Project name. Can be set via variable: BUDDY_PROJECT

-t, --type <type>

Type of the route. Allowed: DIRECT_PROXY (default), CACHED_PROXY, REDIRECT, CLOAKING

-s, --subdomain <subdomain>

Optional sub-name prepended to --domain (e.g.

-d, --domain <domain>

Zone for the route — pass the WHOLE string from bdy domain ls (e.g. "example.com" or "my-app.example.dev"). Do NOT split a multi-level zone into subdomain+domain; the entire bought/claimed string is one zone and goes here as-is. Use --subdomain only to route a sub-name within this zone

--path <path>

Path of the route

--note <note>

Note of the route

--agent-note <note>

Note of the route for AI agents; stored as agent_note and meant to be read before acting on the resource

--target <targets...>

Target of the route (can be used multiple times). Format: "region=default,url=https://example.com,artifact=artifact:version,sandbox=sandbox:endpoint" To use "," in value use , For external url target use url (required), region (optional) For artifact target use artifact (required), region (optional) For sandbox target use sandbox (required), region (optional) Region can be Default, NorthAmerica, Europe, Asia, Oceania, SouthAmerica, Africa, Antarctica or two letter country name If no region is specified or default is used, the target is used as the fallback for all locations. Default region is mandatory

--format <text|json>

Output format: json, text. JSON CLI errors: {error:{code,message,hint}}, exit 1. Default: text (choices: "text", "json")

-h, --help

display help for command

Documentation for bdy v1.25.20

Last modified on Oct 14, 2026

open update

Examples

Route update requires full param set (it's not partial)
bdy distro route update distro-identifier route-id --subdomain=new --domain=test.com --target url=https://example.com$

Return the result as JSON
bdy distro route update my-distro route-id --path /new --format json$