Nodes

Changed on
get/internal/nodes/{node_id}/public-ingress/settings

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/internal/nodes/{node_id}/public-ingress/settings
  • Auth: HTTP bearer

Path parameters

node_idinteger required

Worker node ID

Response

agent_reportsboolean required

Whether the agent reported its addresses: an agent that predates console-managed ingress never does, and keeps its flag.

behind_natboolean required

The listen address is not public but the public address is: traffic crosses a NAT, so the router must forward the ports.

checked_atstring date-time nullable
effective_public_addressstring nullable

The address DNS should point at, as far as Temps can tell.

effective_public_scope'public' | 'private' | 'cgnat' | 'local'

Who can reach an address.

enabledboolean required
http_portinteger required
https_portinteger required
last_errorstring nullable
listen_addressstring nullable

Configured listen address; None means automatic.

listener_errorstring nullable
listening_httpstring nullable
listening_httpsstring nullable
mode'off' | 'fixed' | 'delegated'

What a worker lets its control plane do with public ingress. Set on the worker only (temps join --ingress, temps agent ingress): opening ports on a machine is its owner's decision, whoever runs the control plane.

node_idinteger required
public_addressstring nullable

Configured public address; None means the listen address.

runningboolean nullable

Changes