Skip to content
Proud to collaborate with Microsoft for Startups

kubernetes.cluster.api_resources ​

List all API resources advertised by the cluster (kubectl api-resources equivalent)

List all API resources advertised by the Kubernetes cluster (equivalent to kubectl api-resources).

Calls the server's discovery endpoints:

  • /api/{version} for core (legacy) API groups
  • /apis/{group}/{version} for named API groups

Optionally filters to a single apiGroup by passing the group field (e.g. "apps" for Deployments/ReplicaSets, "" for the core group resources like Pods).

Subresources (those whose name contains /) are always excluded from the output list.

Inputs:

  • connection_uuid: Cloud connection UUID (required)
  • group: If provided, only resources belonging to this apiGroup are returned. Use "" for the core group, "apps", "batch", etc. for named groups. Omit to return all resources across every group.

Outputs:

  • items: List of API resource descriptors — see module docstring for shape.
  • count: Number of items returned.

Plugin required: context.get_plugin("connection").kubernetes_runner_clients(connection_uuid, organization_uuid) must expose api_client (a kubernetes.client.ApiClient instance) so that CoreV1Api and ApisApi can be instantiated from it.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-kubernetes
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes——
groupstringNo——
organization_uuiduuidNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo——
organization_uuiduuidNo——
groupstringNo——
itemsjsonNo——
countintegerNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "kubernetes.cluster.api_resources",
  "initial_data": {
    "connection_uuid": "value"
  }
}