Skip to content
Proud to collaborate with Microsoft for Startups

kubernetes.deployment.get ​

Read a single Deployment's metadata, spec, and status

Reads a single Deployment from the cluster as a Kubernetes object.

If it exists, the sanitized object (apiVersion, kind, metadata, spec, status) is merged onto the workflow envelope alongside exists=True. If it is not found (404), returns exists=False and no object keys.

Inputs:

  • connection_uuid: UUID of the cloud connection (required)
  • namespace: Namespace the Deployment lives in (required)
  • name: Deployment name (required)

Outputs:

  • exists: bool
  • apiVersion, kind, metadata, spec, status: the Deployment itself

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-kubernetes
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes——
namespacestringYes——
namestringYes——
organization_uuiduuidNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo——
organization_uuiduuidNo——
namespacestringNo——
namestringNo——
existsbooleanNo——
apiVersionstringNo——
kindstringNo——
metadatajsonNo——
specjsonNo——
statusjsonNo——
datajsonNo——
binaryDatajsonNo——
stringDatajsonNo——
immutablebooleanNo——
typestringNo——
rulesjsonNo——
aggregationRulejsonNo——
roleRefjsonNo——
subjectsjsonNo——
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.deployment.get",
  "initial_data": {
    "connection_uuid": "value",
    "namespace": "value",
    "name": "value"
  }
}