Skip to main content
POST

Authorizations

​
Authorization
string
header
required

API key passed as Bearer token

Path Parameters

​
id
string
required

Machine ID (e.g. mch_a1b2c3d4)

​
port
integer<uint16>
required

Machine guest port to expose through browser preview. Reserved generic-preview ports are rejected: 22 is SSH-specific and 5900-5999 are desktop/VNC-specific.

Required range: 1 <= x <= 65535

Body

application/json
​
kind
enum<string>
default:tcp

Readiness probe kind.

Available options:
tcp,
http
​
path
string
default:/

HTTP path to check when kind is http.

​
timeout_secs
integer<uint16>
default:30

Maximum time to wait for service readiness.

Required range: 1 <= x <= 120
​
interval_ms
integer<uint64>
default:500

Poll interval between readiness attempts.

Required range: 100 <= x <= 5000

Response

Preview readiness diagnostic result

​
ready
boolean
required

True when route and service readiness both succeeded.

​
route_ready
boolean
required

True when the runtime host route was resolved.

​
service_ready
boolean
required

True when the service accepted the readiness probe.

​
machine_id
string
required
​
port
integer<uint16>
required
​
kind
enum<string>
required
Available options:
tcp,
http
​
checked_at
string<date-time>
required
​
elapsed_ms
integer<uint64>
required
​
attempts
integer<uint32>
required
​
path
string | null
​
code
string | null
Example:

"preview_service_not_ready"

​
error
string | null
​
suggested_action
string | null
Example:

"Start the service, confirm the port, and bind to 0.0.0.0 inside the machine rather than only 127.0.0.1."