get-cloudflow-template

dci get-cloudflow-template templateId

Returns a single CloudFlow template by ID.

Responses

200 (application/json)

OK

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

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)

Not Found - The requested resource does not exist.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

500 (application/json)

Internal Server Error - Something went wrong with the DoiT API server.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: get-cloudflow-template, getcloudflowtemplate