Preview Gateway

Changed on
get/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

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

  • 4b228ebed583Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 1dc3e6788214Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status