Update configuration

PUT
/workspaces
/:workspace
/distributions
/:distribution_id
/routes
/:route_id

Update the configuration of an existing route in a distribution with a PUT request, replacing its settings with the ones you send.

Request

REQUIRED SCOPES

DISTRIBUTION_WRITE

URL PARAMETERS

workspacerequiredstring

The human-readable ID of the workspace

Example: "my-company"

distribution_idrequiredstring

The ID of the distribution

Example: "nZrnl40Y"

route_idrequiredstring

The ID of the route

Example: "dybEM2bg"

GET PARAMETERS

project_namestring

Project name to filter distributions

Example: "my-project"

environment_idstring

Environment ID to filter distributions

Example: "3a4KbBQl"

BODY PARAMETERS

typerequiredstring enum

The type of the route

Allowed enum:

CACHED_PROXY,

REDIRECT,

CLOAKING,

DIRECT_PROXY

domainrequiredstring

Required. Domain of the route; cannot be changed.

targetsrequiredobject

The targets of the route

subdomainstring

Subdomain for the route. For a claimable domain, the rightmost label is extracted as the claim.

pathstring

The path of the route

notestring

Note for this resource

agent_notestring

YAML note for AI agents operating on this resource

Response

RESPONSE BODY

typestring enum

The type of the route

Allowed enum:

CACHED_PROXY,

REDIRECT,

CLOAKING,

DIRECT_PROXY

urlread-onlystring

API endpoint to GET this object

html_urlread-onlystring

Web URL to view this object in Buddy.works

idstring

The ID of the route

subdomainstring

The subdomain of the route

domainstring

The domain of the route

pathstring

The path of the route

zone_typestring enum

The type of DNS zone for custom domain routing

Allowed enum:

ROUTING,

CLAIMABLE,

USER,

CLAIMED,

NS_POINTED,

CNAME_POINTED

targetsobject

The targets of the route

notestring

Note for this resource

agent_notestring

YAML note for AI agents operating on this resource

Last modified on Nov 10, 2026

Update Delete Routes

Request example

curl -X PUT "https://api.buddy.works/workspaces/:workspace/distributions/:distribution_id/routes/:route_id" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "subdomain": "updated-api",
  "targets": {
    "default": {
      "type": "EXTERNAL",
      "external_url": "https://updated.example.com"
    }
  },
  "note": "Notes about this resource",
  "agent_note": "my_custom_field: note for agent"
}'

EXAMPLE RESPONSE

{
  "url": "https://api.buddy.works/workspaces/my-workspace/distributions/gNYmaWYw/routes/dybEM2bg?project_name=my-project",
  "html_url": "https://app.buddy.works/my-workspace/my-project/routing/gNYmaWYw/route/dybEM2bg",
  "id": "dybEM2bg",
  "type": "DIRECT_PROXY",
  "subdomain": "sandbox",
  "domain": "buddy.works",
  "path": "",
  "targets": {
    "Default": {
      "type": "SANDBOX",
      "sandbox": {
        "id": "ynjuqe2kov258",
        "endpoint": "www"
      }
    }
  },
  "note": "Notes about this resource",
  "agent_note": "my_custom_field: note for agent"
}

STATUS

200 OK