Skip to content
AGH RuntimeAPI Reference

Support

AGH Support HTTP endpoints.

Audience
Operators running durable agent work
Focus
API Reference guidance shaped for scanability, day-two clarity, and operator context.
POST/api/support/bundles

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/support/bundles" \  -H "Content-Type: application/json" \  -d '{    "yes": true  }'
{
  "operation": {
    "completed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "download_url": "string",
    "failure_reason": "string",
    "file_name": "string",
    "manifest": {
      "artifact_max_bytes": 0,
      "artifacts": [
        {
          "bytes": 0,
          "included": true,
          "omitted_reason": "string",
          "path": "string",
          "redaction_version": "string",
          "truncated": true
        }
      ],
      "bundle_max_bytes": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "event_summary_max_bytes": 0,
      "log_tail_max_bytes": 0,
      "operation_id": "string",
      "redaction_version": "string",
      "schema_version": "string"
    },
    "operation_id": "string",
    "size_bytes": 0,
    "status": "string",
    "status_url": "string",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
Empty
GET/api/support/bundles/{operation_id}

Path Parameters

operation_id*string

Support bundle operation id

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/support/bundles/string"
{
  "operation": {
    "completed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "download_url": "string",
    "failure_reason": "string",
    "file_name": "string",
    "manifest": {
      "artifact_max_bytes": 0,
      "artifacts": [
        {
          "bytes": 0,
          "included": true,
          "omitted_reason": "string",
          "path": "string",
          "redaction_version": "string",
          "truncated": true
        }
      ],
      "bundle_max_bytes": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "event_summary_max_bytes": 0,
      "log_tail_max_bytes": 0,
      "operation_id": "string",
      "redaction_version": "string",
      "schema_version": "string"
    },
    "operation_id": "string",
    "size_bytes": 0,
    "status": "string",
    "status_url": "string",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
Empty
GET/api/support/bundles/{operation_id}/download

Path Parameters

operation_id*string

Support bundle operation id

Response Body

application/gzip

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/support/bundles/string/download"
"string"
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
{
  "diagnostic": {
    "category": "string",
    "code": "string",
    "data_freshness": "string",
    "doc_url": "string",
    "evidence": {
      "property1": null,
      "property2": null
    },
    "id": "string",
    "message": "string",
    "severity": "string",
    "suggested_command": "string",
    "title": "string"
  },
  "error": "string"
}
Empty