Skip to content
Proud to collaborate with Microsoft for Startups

data.cluster.list ​

List logical Kubernetes clusters for an organization with optional filters.

List logical clusters for an organization with optional filters.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-clusters
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID for tenant isolation.
providerstringNo—Optional provider filter.
cluster_kindstringNo—Optional cluster kind filter.
statusstringNo—Optional normalized status filter.
provider_connection_uuiduuidNo—Optional provider CloudConnection filter.
connection_uuiduuidNo—Optional Kubernetes CloudConnection filter.
include_deletedbooleanNo—Include soft-deleted clusters.
include_connectionbooleanNo—Include sanitized Kubernetes CloudConnection summaries.
limitintegerNo—Maximum rows to return.
offsetintegerNo—Pagination offset.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID echoed from input.
clustersjsonNo—List of sanitized logical cluster records.
countintegerNo—Number of rows returned.
totalintegerNo—Total rows matching filters.
filtersjsonNo—Effective filters applied.
limitintegerNo—Effective limit.
offsetintegerNo—Effective offset.
failure_reasonstringNo—Human-readable failure reason.
failed_stepstringNo—Failed logical step.
failed_layerjsonNo—Engine failed layer when applicable.
failed_at_statestringNo—State where failure occurred.
errorstringNo—Error message.
error_typestringNo—Error class.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
doneYesYesYes——

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "data.cluster.list",
  "initial_data": {
    "organization_uuid": "value"
  }
}