Skip to content
Proud to collaborate with Microsoft for Startups

data.cloudflare.tunnel.persist ​

Persist a CloudflareTunnel (create or restore)

Persist (create or restore) a CloudflareTunnel row.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-cloudflare
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID
cloud_connection_uuiduuidYes—UUID of the backing Cloudflare CloudConnection
cf_tunnel_uuiduuidYes—Cloudflare-assigned tunnel UUID
namestringYes—Tunnel name
tokenstringNo—Plaintext connector token (encrypted at rest)
ingress_configlistNo—Initial ingress rules (DB-owned)
warp_routing_configdictNo—WARP routing config
provider_metadatadictNo—Free-form provider metadata
actorstringNo—Caller initiating the persist

Output Schema ​

FieldTypeRequiredDefaultDescription
cloudflare_tunnel_uuiduuidYes—UUID of the persisted CloudflareTunnel row
cf_tunnel_uuiduuidYes—Cloudflare-assigned tunnel UUID
createdbooleanYes—True when a new row was inserted
restoredbooleanYes—True when a soft-deleted row was restored
persisted_atstringYes—ISO-8601 timestamp
failure_reasonstringNo—Engine-stamped human-readable failure reason
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped step name (DAG path)
failed_layerintegerNo—Engine-stamped layer index (DAG path)
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name
failure_typestringNo—Engine-stamped failure category (atomic path)
failed_actionstringNo—Engine-stamped action method that raised (atomic path)

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—completePersist tunnel
completedNoYesYes—Persisted
failedNoYesNo—Persist failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingcompletecompleted—
pendingfailfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "data.cloudflare.tunnel.persist",
  "initial_data": {
    "organization_uuid": "value",
    "cloud_connection_uuid": "value",
    "cf_tunnel_uuid": "value",
    "name": "value"
  }
}