AnsibleActivityResourceCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/harness/main/json-schema/harness-ansible-activity-resource-collection-schema.json",
  "title": "AnsibleActivityResourceCollection",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/harness-ansible-api-openapi.yml#/components/schemas/AnsibleActivityResourceCollection",
  "type": "array",
  "items": {
    "$ref": "#/$defs/HarnessIacmAnsibleactivity"
  },
  "$defs": {
    "AnsibleActivityMetadata": {
      "type": "object",
      "properties": {
        "activity_status": {
          "type": "string",
          "description": "The status of this activity"
        },
        "git_branch": {
          "type": "string",
          "description": "Git branch associated with this execution"
        },
        "git_commit_message": {
          "type": "string",
          "description": "Git commit message associated with this execution"
        },
        "git_commit_sha": {
          "type": "string",
          "description": "Git commit SHA associated with this execution"
        },
        "git_repo": {
          "type": "string",
          "description": "Git repo associated with this execution"
        },
        "metrics": {
          "$ref": "#/$defs/AnsibleMetrics"
        },
        "pipeline": {
          "type": "string",
          "description": "The unique identifier of any associated pipeline"
        },
        "pipeline_execution_id": {
          "type": "string",
          "description": "The unique identifier for any associated pipeline execution"
        },
        "pipeline_execution_number": {
          "type": "string",
          "description": "The unique number for any associated pipeline execution"
        },
        "pipeline_name": {
          "type": "string",
          "description": "The name of any associated pipeline"
        },
        "pipeline_stage_id": {
          "type": "string",
          "description": "The unique identifier for the associated pipeline stage"
        },
        "plugin_version": {
          "type": "string",
          "description": "The version of the Ansible plugin that produced this activity"
        },
        "results_uuid": {
          "type": "string",
          "description": "The ID of any associated results"
        },
        "trigger": {
          "type": "object",
          "description": "Trigger info for any associated pipeline execution",
          "additionalProperties": true
        }
      }
    },
    "AnsibleMetrics": {
      "type": "object",
      "properties": {
        "circuit_breaker_triggered": {
          "type": "boolean",
          "description": "Whether circuit breaker was triggered"
        },
        "duration_ms": {
          "type": "integer",
          "description": "Duration of ansible run in milliseconds",
          "format": "int64"
        },
        "host_changed": {
          "type": "integer",
          "description": "Number of hosts with changed status",
          "format": "int64"
        },
        "host_failed": {
          "type": "integer",
          "description": "Number of hosts with failed status",
          "format": "int64"
        },
        "host_ok": {
          "type": "integer",
          "description": "Number of hosts with ok status",
          "format": "int64"
        },
        "host_skipped": {
          "type": "integer",
          "description": "Number of hosts with skipped status",
          "format": "int64"
        },
        "host_unreachable": {
          "type": "integer",
          "description": "Number of hosts with unreachable status",
          "format": "int64"
        },
        "output_size_bytes": {
          "type": "integer",
          "description": "Size of structured ansible output in bytes",
          "format": "int64"
        },
        "payload_size_bytes": {
          "type": "integer",
          "description": "Size of payload sent to server in bytes",
          "format": "int64"
        },
        "total_hosts": {
          "type": "integer",
          "description": "Total number of hosts in the ansible run",
          "format": "int64"
        },
        "total_tasks": {
          "type": "integer",
          "description": "Total number of tasks across all hosts",
          "format": "int64"
        }
      },
      "description": "Observability metrics for ansible playbook runs"
    },
    "HarnessIacmAnsibleactivity": {
      "type": "object",
      "properties": {
        "account": {
          "type": "string",
          "description": "Account is the internal customer account ID.",
          "minLength": 1,
          "maxLength": 128
        },
        "created": {
          "type": "integer",
          "description": "Timestamp when the resource was created.",
          "format": "int64"
        },
        "event_type": {
          "type": "string",
          "description": "The type of event that occurred",
          "enum": [
            "activity-execution",
            "activity-dry-run-execution"
          ]
        },
        "id": {
          "type": "string",
          "description": "The unique identifier for this activity"
        },
        "inventories": {
          "type": "string",
          "description": "Inventories associated with this event"
        },
        "metadata": {
          "$ref": "#/$defs/AnsibleActivityMetadata"
        },
        "org": {
          "type": "string",
          "description": "Org is the organisation identifier.",
          "minLength": 1,
          "maxLength": 128
        },
        "playbooks": {
          "type": "string",
          "description": "Playbooks associated with this event"
        },
        "project": {
          "type": "string",
          "description": "Project is the project identifier.",
          "minLength": 1,
          "maxLength": 128
        }
      },
      "required": [
        "account",
        "org",
        "project",
        "inventories",
        "playbooks",
        "id",
        "metadata",
        "created",
        "event_type"
      ]
    }
  }
}