Skip to main content

list-cloudflows 

dci list-cloudflows [flags]

Returns a cursor-paginated list of CloudFlows.

CLI default view

dci list-cloudflows presents a curated table by default:

  • Columns: name, id, published, trigger (from triggerType), run status (from lastExecutionStatus), last run (UTC) (from lastExecutedTime), and next run (UTC) (from nextRun).
  • In interactive tables, last run (UTC) and next run (UTC) render in your local timezone (titled (local)); machine formats, agent mode, and --utc keep UTC — see Timestamps and timezones.
  • --output json and explicit -C/--fields selections return the raw fields documented below.

Flows are addressed by ID only — export-cloudflow-flow, refine-cloud-flow, test-run-cloudflow-flow, and the run commands take the literal id shown here; there is no name resolution for flows. The API does not filter or sort this listing server-side, so use --search to narrow it.

Examples​

# Your CloudFlows, with the IDs that export, refine, and test-run take.
dci list-cloudflows
# Find flows by keyword (client-side, case-insensitive, scans every page).
dci list-cloudflows --search cleanup
# Every page as JSON, for scripts.
dci list-cloudflows --all --output json
# Browse in the full-screen viewer.
dci list-cloudflows -M interactive

Flags​

FlagTypeDefaultExampleDescription
--max-resultsinteger50Maximum number of flows to return (1–500). Defaults to 50.
--page-tokenstringOpaque cursor for the next page, taken from pageToken in the previous response. Omit to start from the beginning.

Every command also accepts the CLI-wide flags for output shaping — see Output formats and Table output options.

Output​

Paginated list of CloudFlows.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

FieldTypeDescription
itemsarray of objectList of CloudFlows.
items[].idstring
items[].namestring
items[].descriptionstring
items[].instructionsstring
items[].publishedboolean
items[].triggerTypestring
items[].createTimestring (date-time)
items[].updateTimestring (date-time)
items[].lastExecutedTimestring (date-time)
items[].lastExecutionStatusstringOne of: "pending", "running", "complete", "pending-approval", "failed", "sleeping", "stopped".
items[].nextRunstring (date-time)Next scheduled execution time. null when the CloudFlow has no active schedule.
pageTokenstringOpaque cursor for the next page. null when there are no more CloudFlows.
rowCountintegerAlways null. Row count is not computed for this endpoint.
Raw JSON schema
{
  "type": "object",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "name",
          "published",
          "createTime"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "instructions": {
            "type": "string",
            "nullable": true
          },
          "published": {
            "type": "boolean"
          },
          "triggerType": {
            "type": "string",
            "nullable": true
          },
          "createTime": {
            "type": "string",
            "format": "date-time"
          },
          "updateTime": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "lastExecutedTime": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "lastExecutionStatus": {
            "type": "string",
            "nullable": true,
            "enum": [
              "pending",
              "running",
              "complete",
              "pending-approval",
              "failed",
              "sleeping",
              "stopped"
            ]
          },
          "nextRun": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Next scheduled execution time. `null` when the CloudFlow has no active schedule."
          }
        }
      },
      "description": "List of CloudFlows."
    },
    "pageToken": {
      "type": "string",
      "nullable": true,
      "description": "Opaque cursor for the next page. `null` when there are no more CloudFlows."
    },
    "rowCount": {
      "type": "integer",
      "nullable": true,
      "description": "Always `null`. Row count is not computed for this endpoint."
    }
  }
}

Errors​

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status to exit code mapping
HTTP statusExit codeError codeMeaning
40030VALIDATION_ERRORThe arguments or request body were rejected. Review the command's flags and payload.
40110AUTHENTICATION_FAILEDNot signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
40311PERMISSION_DENIEDThe DoiT user or the active customer context does not have access.
50040API_SERVER_ERRORThe API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: listcloudflows