Skip to main content
ZStack
Platform Operations/Platform Health

GetPlatformHealthOverview

Get raw facts for ZCF platform self-health

GET/api/v1/platform-health/overview

Operation ID

GetPlatformHealthOverview

Since

1.2.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

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • generatedAt
    String

    Generated at for this resource

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

  • sources
    List

    Sources for this resource

    Example: (nested array)

    • name
      String

      Human-readable name of this resource

      Example: my-resource

    • readAt
      String

      Read at for this resource

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

    • cached
      Boolean

      Cached for this resource

      Example: true

    • error
      String

      Error details returned when stream processing fails

      Example: "upgrade failed: timeout"

  • components
    List

    List of affected or referenced components

    Example: (nested array)

    • component
      Object

      Component for this resource

      • uuid
        String

        Unique identifier of this resource

        Example: value

      • name
        String

        Human-readable name of this resource

        Example: my-resource

      • category
        String

        Category for this resource

        Example: value

      • installType
        String

        Install type for this resource

        Example: value

      • deliveryType
        String

        Delivery type for this resource

        Example: value

      • bundleName
        String

        Bundle name for this resource

        Example: value

      • bundleManagementStatus
        String

        Bundle management status for this resource

        Example: value

      • configState
        String

        Config state for this resource

        Example: value

    • instances
      List

      Instances for this resource

      Example: (nested array)

      • uuid
        String

        Unique identifier of this resource

        Example: value

      • componentUuid
        String

        Component uuid for this resource

        Example: value

      • nodeUuid
        String

        Node uuid for this resource

        Example: value

      • lcaUuid
        String

        Lca uuid for this resource

        Example: value

      • state
        String

        State for this resource

        Example: value

      • runtimeStatus
        String

        Runtime status for this resource

        Example: value

      • message
        String

        Message for this resource

        Example: value

      • updatedAt
        String

        Updated at for this resource

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

      • services
        List

        Services for this resource

        Example: (nested array)

        • uuid
          String

          Unique identifier of this resource

          Example: value

        • name
          String

          Human-readable name of this resource

          Example: my-resource

        • type
          String

          Resource or component type

          Example: value

        • runtimeName
          String

          Runtime name for this resource

          Example: value

        • runtimeStatus
          String

          Runtime status for this resource

          Example: value

        • message
          String

          Message for this resource

          Example: value

        • updatedAt
          String

          Updated at for this resource

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

      • nodeIp
        String

        Node ip for this resource

        Example: value

      • nodeName
        String

        Node name for this resource

        Example: value

  • storageSamples
    List

    Storage samples for this resource

    Example: (nested array)

    • capacityItemId
      String

      Capacity item id for this resource

      Example: value

    • storageType
      String

      Storage type for this resource

      Example: value

    • componentId
      String

      Component id for this resource

      Example: value

    • componentName
      String

      Component name for this resource

      Example: value

    • mountPointHash
      String

      Mount point hash for this resource

      Example: value

    • mountPointMasked
      String

      Mount point masked for this resource

      Example: value

    • totalBytes
      Long

      Total bytes for this resource

      Example: 0

    • usedBytes
      Long

      Used bytes for this resource

      Example: 0

    • availableBytes
      Long

      Available bytes for this resource

      Example: 0

    • usagePercent
      Long

      Usage percent for this resource

      Example: 0

    • updatedAt
      String

      Updated at for this resource

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

    • name
      String

      Human-readable name of this resource

      Example: my-resource

    • storageRole
      String

      Storage role for this resource

      Example: value

    • componentUuid
      String

      Component uuid for this resource

      Example: value

    • component
      String

      Component for this resource

      Example: value

    • uuid
      String

      Unique identifier of this resource

      Example: value

    • filesystemId
      String

      Filesystem id for this resource

      Example: value

    • lcaUuid
      String

      Lca uuid for this resource

      Example: value

    • nodeFqdn
      String

      Node fqdn for this resource

      Example: value

  • notificationChannels
    List

    Notification channels for this resource

    Example: (nested array)

    • id
      String

      Unique identifier of this resource

      Example: value

    • name
      String

      Human-readable name of this resource

      Example: my-resource

    • type
      String

      Resource or component type

      Example: value

    • enabled
      Boolean

      Enabled for this resource

      Example: true

    • consecutiveFailures
      Integer

      Consecutive failures for this resource

      Example: 10

    • message
      String

      Message for this resource

      Example: value

    • updatedAt
      String

      Updated at for this resource

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

  • sentinel
    Object

    Sentinel for this resource

    • message
      String

      Message for this resource

      Example: value

    • updatedAt
      String

      Updated at for this resource

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

    • status
      String

      Status for this resource

      Example: value

  • externalConnections
    List

    External connections for this resource

    Example: (nested array)

    • id
      String

      Unique identifier of this resource

      Example: value

    • name
      String

      Human-readable name of this resource

      Example: my-resource

    • product
      String

      Product for this resource

      Example: value

    • status
      String

      Status for this resource

      Example: value

    • message
      String

      Message for this resource

      Example: value

    • updatedAt
      String

      Updated at for this resource

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

Change History

View all change history

  • Change Time

    AddedResponse fields nodeIp, nodeName
    View API

  • Change Time

    AddedResponse fields nodeIp, nodeName
    View API

  • Change Time

    AddedResponse fields filesystemId, nodeFqdn
    View API

  • Change Time

    AddedResponse fields storageRole
    View API