data.cloudflare.tunnel.persist ​
Persist a CloudflareTunnel (create or restore)
Persist (create or restore) a CloudflareTunnel row.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-cloudflare |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Organization UUID |
cloud_connection_uuid | uuid | Yes | — | UUID of the backing Cloudflare CloudConnection |
cf_tunnel_uuid | uuid | Yes | — | Cloudflare-assigned tunnel UUID |
name | string | Yes | — | Tunnel name |
token | string | No | — | Plaintext connector token (encrypted at rest) |
ingress_config | list | No | — | Initial ingress rules (DB-owned) |
warp_routing_config | dict | No | — | WARP routing config |
provider_metadata | dict | No | — | Free-form provider metadata |
actor | string | No | — | Caller initiating the persist |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
cloudflare_tunnel_uuid | uuid | Yes | — | UUID of the persisted CloudflareTunnel row |
cf_tunnel_uuid | uuid | Yes | — | Cloudflare-assigned tunnel UUID |
created | boolean | Yes | — | True when a new row was inserted |
restored | boolean | Yes | — | True when a soft-deleted row was restored |
persisted_at | string | Yes | — | ISO-8601 timestamp |
failure_reason | string | No | — | Engine-stamped human-readable failure reason |
failed_at_state | string | No | — | Engine-stamped state when the workflow failed |
failed_step | string | No | — | Engine-stamped step name (DAG path) |
failed_layer | integer | No | — | Engine-stamped layer index (DAG path) |
error | string | No | — | Engine-stamped exception message |
error_type | string | No | — | Engine-stamped exception class name |
failure_type | string | No | — | Engine-stamped failure category (atomic path) |
failed_action | string | No | — | Engine-stamped action method that raised (atomic path) |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | complete | Persist tunnel |
completed | No | Yes | Yes | — | Persisted |
failed | No | Yes | No | — | Persist failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | complete | completed | — |
pending | fail | failed | — |
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"
}
}