Skip to content
Proud to collaborate with Microsoft for Startups

data.cluster.get ​

Fetch one logical Kubernetes cluster by UUID for an organization.

Fetch a single logical cluster by UUID, scoped to an organization.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-clusters
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID for tenant isolation.
cluster_uuiduuidYes—Logical cluster UUID to fetch.
include_connectionbooleanNo—Include sanitized Kubernetes CloudConnection summary.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID echoed from input.
cluster_uuiduuidNo—Logical cluster UUID.
foundbooleanNo—True when a non-deleted cluster row was found.
clusterjsonNo—Sanitized logical cluster record.
connectionjsonNo—Sanitized Kubernetes CloudConnection summary when requested.
providerstringNo—Provider key.
cluster_kindstringNo—eks, gke, aws-vm, gcp-vm, or mgc-kubernetes.
provider_connection_uuiduuidNo—Provider CloudConnection UUID.
provider_cluster_refstringNo—Provider-side cluster identifier.
connection_uuiduuidNo—Kubernetes CloudConnection UUID.
statusstringNo—Last persisted normalized status.
persisted_statusstringNo—Raw persisted status before read-side stale projection.
status_sourcestringNo—Source of the returned status value.
status_stalebooleanNo—True when the persisted status is too old to present as live.
status_refresh_requiredbooleanNo—True when callers should run cluster.refresh-status.
refreshed_atstringNo—Last status refresh timestamp.
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.get",
  "initial_data": {
    "organization_uuid": "value",
    "cluster_uuid": "value"
  }
}