chef.automate.api.cfgmgmt.response.Run

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/progress-software/json-schema/progress-software-chef-automate-api-cfgmgmt-response-run-schema.json",
  "title": "chef.automate.api.cfgmgmt.response.Run",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/progress-software-configmgmt-api-openapi.yml#/components/schemas/chef.automate.api.cfgmgmt.response.Run",
  "type": "object",
  "properties": {
    "chef_tags": {
      "description": "List of tags associated with the node.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "chef_version": {
      "description": "Chef-client version on the node.",
      "type": "string"
    },
    "cloud_provider": {
      "type": "string"
    },
    "cookbooks": {
      "description": "List of cookbooks associated with the node.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "deprecations": {
      "description": "Intentionally blank.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/chef.automate.api.cfgmgmt.response.Deprecation"
      }
    },
    "dmi_system_manufacturer": {
      "type": "string"
    },
    "dmi_system_serial_number": {
      "type": "string"
    },
    "domain": {
      "type": "string"
    },
    "end_time": {
      "description": "End time of the infra run.",
      "type": "string",
      "format": "date-time"
    },
    "environment": {
      "description": "The environment for the node.",
      "type": "string"
    },
    "error": {
      "description": "Chef Error information, available on failed runs.",
      "$ref": "#/$defs/chef.automate.api.cfgmgmt.response.ChefError"
    },
    "expanded_run_list": {
      "description": "Expanded run list for the node.",
      "$ref": "#/$defs/chef.automate.api.cfgmgmt.response.ExpandedRunList"
    },
    "fqdn": {
      "description": "FQDN of the node.",
      "type": "string"
    },
    "hostname": {
      "type": "string"
    },
    "id": {
      "description": "Id of the infra node run.",
      "type": "string"
    },
    "ip6address": {
      "description": "IP 6 Address for the node.",
      "type": "string"
    },
    "ipaddress": {
      "description": "IP Address for the node.",
      "type": "string"
    },
    "kernel_release": {
      "type": "string"
    },
    "kernel_version": {
      "type": "string"
    },
    "macaddress": {
      "type": "string"
    },
    "memory_total": {
      "type": "string"
    },
    "node_id": {
      "description": "The chef_guid associated with the node.",
      "type": "string"
    },
    "node_name": {
      "description": "Name of the node.",
      "type": "string"
    },
    "organization": {
      "description": "The organization the node is associated with.",
      "type": "string"
    },
    "platform": {
      "description": "Full platform string for the node (family + version).",
      "type": "string"
    },
    "platform_family": {
      "description": "Platform family for the node.",
      "type": "string"
    },
    "platform_version": {
      "description": "Platform version for the node.",
      "type": "string"
    },
    "policy_group": {
      "description": "Policy group associated with the node.",
      "type": "string"
    },
    "policy_name": {
      "description": "Policy name associated with the node.",
      "type": "string"
    },
    "policy_revision": {
      "description": "Policy revision associated with the node.",
      "type": "string"
    },
    "projects": {
      "description": "List of projects the node belongs to.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "recipes": {
      "description": "List of recipes the node calls.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "resource_names": {
      "description": "List of resource names for the node.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "resources": {
      "description": "Intentionally blank.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/chef.automate.api.cfgmgmt.response.Resource"
      }
    },
    "roles": {
      "description": "List of roles associated with the node.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "run_list": {
      "description": "Run list for the node.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "source": {
      "description": "Source of the node run (e.g. chef-solo).",
      "type": "string"
    },
    "source_fqdn": {
      "description": "Chef server associated with the node.",
      "type": "string"
    },
    "start_time": {
      "description": "Start time of the infra run.",
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "description": "Status of the infra node run.",
      "type": "string"
    },
    "tags": {
      "description": "Unused field.",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "timezone": {
      "type": "string",
      "title": "timezone of the node"
    },
    "total_resource_count": {
      "description": "Resource count reported on the infra node run.",
      "type": "integer",
      "format": "int32"
    },
    "updated_resource_count": {
      "description": "Count of resources updated in the infra node run.",
      "type": "integer",
      "format": "int32"
    },
    "uptime_seconds": {
      "description": "Count in seconds that the node has been active.",
      "type": "integer",
      "format": "int32"
    },
    "versioned_cookbooks": {
      "description": "List of versioned cookbooks associated with the node.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/chef.automate.api.cfgmgmt.response.VersionedCookbook"
      }
    },
    "virtualization_role": {
      "type": "string"
    },
    "virtualization_system": {
      "type": "string"
    }
  },
  "$defs": {
    "chef.automate.api.cfgmgmt.response.ChefError": {
      "type": "object",
      "properties": {
        "backtrace": {
          "description": "Stacktrace for the failure.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "class": {
          "description": "Class for the error.",
          "type": "string"
        },
        "description": {
          "description": "Description for the error.",
          "$ref": "#/$defs/chef.automate.api.cfgmgmt.response.Description"
        },
        "message": {
          "description": "Error message for the failed run.",
          "type": "string"
        }
      }
    },
    "chef.automate.api.cfgmgmt.response.Deprecation": {
      "type": "object",
      "properties": {
        "location": {
          "description": "Location of the deprecated code.",
          "type": "string"
        },
        "message": {
          "description": "Message for the deprecation.",
          "type": "string"
        },
        "url": {
          "description": "Url reference for the deprecation.",
          "type": "string"
        }
      }
    },
    "chef.automate.api.cfgmgmt.response.Description": {
      "type": "object",
      "properties": {
        "sections": {
          "description": "More information about the error.",
          "type": "array",
          "items": {
            "type": "object"
          }
        },
        "title": {
          "description": "Title for the error description.",
          "type": "string"
        }
      }
    },
    "chef.automate.api.cfgmgmt.response.ExpandedRunList": {
      "type": "object",
      "properties": {
        "id": {
          "description": "Id of the run list collection.",
          "type": "string"
        },
        "run_list": {
          "description": "Intentionally blank.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/chef.automate.api.cfgmgmt.response.RunList"
          }
        }
      }
    },
    "chef.automate.api.cfgmgmt.response.Resource": {
      "type": "object",
      "properties": {
        "conditional": {
          "description": "Conditional rule associated with the resource.",
          "type": "string"
        },
        "cookbook_name": {
          "description": "Cookbook name associated with the resource.",
          "type": "string"
        },
        "cookbook_version": {
          "description": "Version of the cookbook associated with the resource.",
          "type": "string"
        },
        "delta": {
          "description": "Change diff for the resource (if it was changed during the run).",
          "type": "string"
        },
        "duration": {
          "description": "Duration of the resource processing.",
          "type": "string"
        },
        "error": {
          "description": "Chef Error information, available on failed runs.",
          "$ref": "#/$defs/chef.automate.api.cfgmgmt.response.ChefError"
        },
        "id": {
          "description": "Id of the resource.",
          "type": "string"
        },
        "ignore_failure": {
          "description": "Boolean that denotes whether or not the resource failure should be ignored.",
          "type": "boolean"
        },
        "name": {
          "description": "Name for the resource.",
          "type": "string"
        },
        "recipe_name": {
          "description": "Name of the recipe associated with the resource.",
          "type": "string"
        },
        "result": {
          "description": "String result of the resource.",
          "type": "string"
        },
        "status": {
          "description": "Status of the resource (e.g. 'up-to-date').",
          "type": "string"
        },
        "type": {
          "description": "Resource type.",
          "type": "string"
        }
      }
    },
    "chef.automate.api.cfgmgmt.response.RunList": {
      "type": "object",
      "properties": {
        "children": {
          "description": "Intentionally blank.",
          "type": "array",
          "items": {
            "$ref": "#/$defs/chef.automate.api.cfgmgmt.response.RunList"
          }
        },
        "name": {
          "description": "Name of run list item.",
          "type": "string"
        },
        "skipped": {
          "description": "Boolean denoting whether or not the run list item was skipped.",
          "type": "boolean"
        },
        "type": {
          "description": "Type of run list item (e.g. 'recipe').",
          "type": "string"
        },
        "version": {
          "description": "Version of run list item.",
          "type": "string"
        }
      }
    },
    "chef.automate.api.cfgmgmt.response.VersionedCookbook": {
      "type": "object",
      "properties": {
        "name": {
          "description": "Name of the cookbook.",
          "type": "string"
        },
        "version": {
          "description": "Version of the cookbook.",
          "type": "string"
        }
      }
    }
  }
}