Ingress

Create a tunnel for a managed domain and run it on workers.

Changed on

Cloudflare Tunnel takes values.dns_provider_id (a Cloudflare DNS provider) and values.domain (a zone managed by it, or a subdomain of one). Every worker in node_ids must allow ingress (temps agent ingress delegated). Apps under the domain are then published automatically: adding app.<domain> to an environment is enough.

post/ingress/connectors

Request

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

Request body

namestring required

Lowercase letters, digits and hyphens; names the tunnel temps-<name>.

node_idsinteger[] required

Nodes that run a connector replica.

providerstring required

The provider's kind, from GET /ingress/providers.

valuesobject

Answers to the provider's setup fields, by field key. DNS provider fields take the provider's id; every other field takes a string.

Response

auto_publishboolean required
created_atstring date-time required
dns_provider_idinteger nullable
dns_targetstring nullable

Where published hostnames point.

domainstring required
edge_portinteger required
external_idstring nullable
idinteger required
last_errorstring nullable
namestring required
providerstring required
statusstring required

Changes