get-cloudflow-template

dci get-cloudflow-template templateId

Returns a single CloudFlow template by ID.

Output

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
`id`	string	Unique identifier of the template.
`name`	string	Human-readable display name of the template.
`description`	string	Short summary of what the template does and which use case it addresses.
`instructions`	string	Step-by-step operator guidance for configuring a flow created from this template. `null` when no instructions have been authored.
`createTime`	string (date-time)	ISO 8601 (UTC) creation timestamp.
`updateTime`	string (date-time)	ISO 8601 (UTC) last-modified timestamp. `null` if never modified.

Raw JSON schema

{
  "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."
    }
  }
}

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.
404	20	`RESOURCE_NOT_FOUND`	The requested resource does not exist. Check the identifier argument.
500	40	`API_SERVER_ERROR`	The API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: getcloudflowtemplate

Output​

Errors​

Output

Errors