bdy sandbox endpoint add

$bdy sandbox endpoint add|create [options] <identifier>

Add an endpoint exposing a sandbox port. The server must listen on 0.0.0.0, otherwise it is unreachable Required scopes: SANDBOX_WRITE

ARGUMENTS

identifier

Sandbox identifier (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

-p, --project <name>

Project name. Can be set via variable: BUDDY_PROJECT

--scope <scope>

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

--environment

BUDDY_PROJECT, linked project)

--environment <identifier>

Environment identifier

-n, --name <name>

Endpoint name

-e, --endpoint <endpoint>

[ip:]port

-t, --type <type>

Endpoint type (HTTP, TLS, or TCP) (default: "HTTP")

-r, --ep-region <region>

override default region ("eu", "us", "as")

--whitelist <cidrs...>

Whitelist provided IP CIDRs. Use "*" to allow all

--timeout <seconds>

Enforce connection timeout in seconds

-h, --host <host>

Provide custom HTTP host header

--header <headers...>

Header key:value to add to the request

--response-header <headers...>

Header key:value to add to the response

--useragent <useragent...>

Whitelist browser user-agent by contained text or regular expressions (e.g. /my-user-agent/). By Default all are allowed

-s, --serve <directory>

Serve files from a directory inside the sandbox

-a, --auth <user:pass>

Enforce HTTP basic authorization

-b, --buddy

Enforce HTTP Buddy authorization

-l, --log

Log HTTP requests

-v, --verify

Enforce TLS verify

-2, --http2

Enforce HTTP/2

-c, --compression

Turn on HTTP response compression

--ca <ca>

Path to a TLS PEM CA certificate for TLS auth

--circuit-breaker <threshold>

Turn on circuit breaker. Provide the failure-rate threshold as a percentage between 0 and 100

-k, --key <key>

Path to a TLS key

--cert <cert>

Path to a TLS PEM certificate

-i, --terminate <at>

Terminate TLS at "target", "agent", "region". By default TLS is terminated at "region"

--format <text|json>

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

--help

display help for command

Documentation for bdy v1.25.20

Last modified on Oct 14, 2026

destroy delete

Examples

Create http endpoint on port 80 (http server must listen on 0.0.0.0)
bdy sb ep create sandbox-identifier -e 80$

Create http server and serve files from sandbox directory
bdy sb ep create sandbox-identifier -s /path/to/dir$

Create tcp endpoint on port 22 with name (tcp server must listen on 0.0.0.0)
bdy sb ep create sandbox-identifier -t TCP -e 22 -n test$

Return the result as JSON
bdy sandbox endpoint add my-sandbox --name web --type HTTP --endpoint 8080 --format json$