list-cloudflow-templates

dci list-cloudflow-templates [flags]

Returns the catalogue of available CloudFlow templates (blueprints). Templates are read-only. To create a flow from a template, use POST /flows with a templateId.

Flags

--max-results: (integer default:50)

--page-token: (string)

Output

OK

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

Field	Type	Description
items	array of object
items[].id	string	Unique identifier of the template.
items[].name	string	Human-readable display name of the template.
items[].description	string	Short summary of what the template does and which use case it addresses.
items[].instructions	string	Step-by-step operator guidance for configuring a flow created from this template. null when no instructions have been authored.
items[].createTime	string (date-time)	ISO 8601 (UTC) creation timestamp.
items[].updateTime	string (date-time)	ISO 8601 (UTC) last-modified timestamp. null if never modified.
pageToken	string	Opaque cursor for the next page. null when there are no more results.
rowCount	integer	Total number of templates matching the current query.

Raw JSON schema

{
  "type": "object",
  "description": "Cursor-paginated list of CloudFlow templates.",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A read-only CloudFlow template (blueprint). Use `POST /flows` with `templateId` to create a new flow initialised from this template.",
        "required": [
          "id",
          "name",
          "createTime"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier of the template."
          },
          "name": {
            "type": "string",
            "description": "Human-readable display name of the template."
          },
          "description": {
            "type": "string",
            "description": "Short summary of what the template does and which use case it addresses."
          },
          "instructions": {
            "type": "string",
            "nullable": true,
            "description": "Step-by-step operator guidance for configuring a flow created from this template. `null` when no instructions have been authored."
          },
          "createTime": {
            "type": "string",
            "format": "date-time",
            "description": "ISO 8601 (UTC) creation timestamp."
          },
          "updateTime": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "ISO 8601 (UTC) last-modified timestamp. `null` if never modified."
          }
        }
      }
    },
    "pageToken": {
      "type": "string",
      "nullable": true,
      "description": "Opaque cursor for the next page. `null` when there are no more results."
    },
    "rowCount": {
      "type": "integer",
      "nullable": true,
      "description": "Total number of templates matching the current query."
    }
  }
}

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	Exit code	Error code	Meaning
400	30	VALIDATION_ERROR	The arguments or request body were rejected. Review the command's flags and payload.
401	10	AUTHENTICATION_FAILED	Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
403	11	PERMISSION_DENIED	The DoiT user or the active customer context does not have access.
500	40	API_SERVER_ERROR	The API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: listcloudflowtemplates