Skip to main content
Routes map a domain and published port into a room. Use them when you want a stable URL for something running inside a room, such as a web app, webhook endpoint, or HTTP integration. This is the normal way to publish an HTTP service from a room. A common pattern is: an agent or service creates a web app in the room, serves it on a published port, and then a route gives that app a stable URL. For deployment basics, see Deploy Services with MeshAgent. Routes are managed from the MeshAgent CLI.

​
How routes work

  • A service in the room listens on an HTTP port.
  • That port is marked as published in the service config.
  • The route maps a domain to that room and published port.

​
Create a route

Use a MeshAgent-managed domain such as *.meshagent.app:
  1. Deploy a service that exposes an HTTP endpoint and marks its port as published.
  2. Create a route:
meshagent route create --room my-room --port 5002 --domain my-app.meshagent.app
  1. The route is ready as soon as it is created.

​
Mark the port as published

In your service config, the HTTP port must be marked as published: 
ports:
  - num: 5002
    type: http
    published: true

​
Manage routes

meshagent route list
meshagent route show my-app.meshagent.app
meshagent route update my-app.meshagent.app --port 5003
meshagent route delete my-app.meshagent.app
To create or update a route, you need permission to administer the target room.

​
Access control note

If the published port is not public, requests must include a participant token. This lets you keep a stable URL while still requiring authentication.