Skip to main content

list-cloudflows 

dci list-cloudflows [flags]

Returns a cursor-paginated list of CloudFlows.

Flags​

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

--page-token: (string)

Responses​

200 (application/json)​

Paginated list of CloudFlows.

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

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

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: list-cloudflows, listcloudflows