Skip to main content
API Explorer|API Explorer
Platform Operations/Platforms
GETPlatformSince 1.0SynchronousAuth Required

GetHealthHistory

Retrieve historical health check results for a platform.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Query Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    UUID of the platform to retrieve health history for

Query Parameters

  • limitInteger

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

    Example: 0

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    List of health check results in reverse chronological order

    Example: (nested array)

    • platformIdString

      ID of the platform this health check result is associated with

      Example: plat-abc123-def456

    • timestampString

      Timestamp for this resource

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

    • statusString

      Health check outcome status (healthy, unhealthy)

      Example: healthy

    • failureReasonString

      Reason for health check failure if status is unhealthy

      Example: API endpoint unreachable

    • fixAttemptedBoolean

      Whether an auto-fix was attempted after this check

      Example: false

    • fixSucceededBoolean

      Whether the auto-fix attempt succeeded

      Example: false

    • latencyMsString

      Round-trip latency in milliseconds for this check

      Example: 120

Endpoint

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

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

Operation ID

GetHealthHistory

Permalink

Request Example

curl -X GET '{host}/api/v1/platforms/{uuid}/health-history' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history