Sign in
Preview Gateway

patch/preview-gateway/settings

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/preview-gateway/settings
  • Auth: HTTP bearer

Request body

auto_upgradeboolean nullable
container_namestring nullable

Docker container name for this instance's gateway; empty resets it to the default. Change it only when several Temps instances share one Docker daemon: each needs its own name and host port. A new name first removes this instance's gateway under the old one, and while the gateway is enabled it is then created under the new one. Refused while this host has sandboxes: their networks keep the current name.

enabledboolean nullable

Turn the gateway off (its containers are removed at once, so preview URLs stop being served) or on (it is created again).

host_portinteger nullable
imagestring nullable

Response

auto_upgradeboolean required
container_namestring required

Docker container name of this instance's gateway.

default_container_namestring required

The default container name. Only installs that share one Docker daemon with another Temps instance need a different one.

default_host_portinteger required

The compile-time default host port.

default_imagestring required

The compile-time default image — exposed so the UI can offer a "Reset to default" link without round-tripping.

enabledboolean required

Whether Temps runs the gateway. While false its containers are removed and workspace preview URLs are not served.

host_portinteger required
imagestring required

Changes