Ingress

List the tunnel providers this control plane offers.

Changed on

Each entry describes its setup fields; answer them by key in create_ingress_connector.

get/ingress/providers

Request

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

Response

dns'automatic' | 'manual' | 'provider_hostname' required

Who makes the published hostnames resolve.

docs_urlstring nullable
kindstring required

Stored on the connector, e.g. cloudflare_tunnel.

namestring required
needs_public_ipboolean required

Whether the worker needs a public address. Tunnels do not.

requirementsstring[] required

What the operator needs before starting, one line each.

summarystring required
works_behind_cgnatboolean required

Whether it works when the ISP puts the worker behind carrier-grade NAT.

Changes