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

TriggerHealthCheck

Immediately trigger a health check for a platform and return the result.

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    UUID of the platform to trigger the health check on

Responses

200 OK

On success, this API returns the following response structure.

  • 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

POST/api/v1/platforms/{uuid}/health-check

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

Operation ID

TriggerHealthCheck

Permalink

Request Example

curl -X POST '{host}/api/v1/platforms/{uuid}/health-check' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"key": "value"}'

Response Example

200
{
  "platformId": "plat-abc123-def456",
  "timestamp": "example",
  "status": "healthy",
  "failureReason": "API endpoint unreachable",
  "fixAttempted": false,
  "fixSucceeded": false,
  "latencyMs": 120
}

Change History

This API has no change history records yet.

View all change history