Ingress

Choose how a hostname reaches visitors.

Changed on

automatic lets the most specific tunnel covering it publish it; tunnel with connector_id pins it to that tunnel (adding a domain "through a tunnel"); off keeps every tunnel away from it, for DNS managed elsewhere. It is published once an environment serves it.

put/ingress/hostnames/{hostname}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/ingress/hostnames/{hostname}
  • Auth: HTTP bearer

Path parameters

hostnamestring required

Request body

connector_idinteger nullable

Required with mode tunnel.

mode'automatic' | 'tunnel' | 'off' required

How one hostname reaches visitors, as the operator chose it (ADR 058 D9).

Response

chosen_connector_idinteger nullable

The tunnel chosen for it, with mode tunnel.

connector_idinteger nullable

The tunnel that publishes it, or would once detail is dealt with.

connector_namestring nullable
detailstring required

What is happening; when it is not published, why and what to do.

hostnamestring required
mode'automatic' | 'tunnel' | 'off' required

How one hostname reaches visitors, as the operator chose it (ADR 058 D9).

published_atstring date-time nullable
served_by_workersboolean required

Whether workers serve it. A tunnel only publishes those.

statestring required

published, pending, error or not_published.

Changes