Skip to main content
Platform Operations/Platforms

GetHealthHistory

Retrieve historical health check results for a platform.

GET/api/v1/platforms/{uuid}/health-history

Operation ID

GetHealthHistory

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • uuid
    StringRequired

    UUID of the platform to retrieve health history for

Query Parameters

  • limit
    Integer

    Maximum number of historical results to return Maximum number of historical results to return

    Example: 0

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    List of health check results in reverse chronological order

    Example: (nested array)

    • platformId
      String

      ID of the platform this health check result is associated with

      Example: plat-abc123-def456

    • timestamp
      String

      Timestamp for this resource

      Example: 2026-01-15T08:00:00Z

    • status
      String

      Health check outcome status (healthy, unhealthy)

      Example: healthy

    • failureReason
      String

      Reason for health check failure if status is unhealthy

      Example: API endpoint unreachable

    • fixAttempted
      Boolean

      Whether an auto-fix was attempted after this check

      Example: false

    • fixSucceeded
      Boolean

      Whether the auto-fix attempt succeeded

      Example: false

    • latencyMs
      String

      Round-trip latency in milliseconds for this check

      Example: 120