Skip to main content
📣 Try Nexigon today — sign up for a free account, no credit card required. 📣
Nexigon Docs
Documentation

Cluster API

Actions in the cluster namespace of the Nexigon Hub API.

cluster_GetDetails

POST/api/v1/actions/invoke/cluster_GetDetails

Get information about the cluster.

Request GetClusterDetailsAction

Fields (JSON object)

  • includeTerminated(from include_terminated)optional

    Include terminated nodes in the response.

    boolean

Response GetClusterDetailsOutput

Fields (JSON object)

  • nodesrequired

    Nodes of the cluster.

    array<ClusterNode>

    Items

    ClusterNode

    Fields (JSON object)

    • nodeId(from node_id)required

      ID of the cluster node.

      ClusterNodeIdstring
    • nameoptional

      Name of the cluster node.

      string
    • statusrequired

      Status of the cluster node.

      ClusterNodeStatus

      Casesexternally

      • Active

        Node is active and running.

        Value: "Active"

      • Terminated

        Node has been terminated.

        Value: "Terminated"

    • joinedAt(from joined_at)required

      Timestamp when the node joined the cluster.

      Timestampstring
    • uptimeSecs(from uptime_secs)required

      Uptime of the node in seconds.

      integer
    • lastHeartbeat(from last_heartbeat)required

      Timestamp when the node last reported a heartbeat.

      Timestampstring
    • terminatedAt(from terminated_at)optional

      Timestamp when the node was terminated.

      Timestampstring
    • terminationReason(from termination_reason)optional

      Reason why the node was terminated.

      ClusterNodeTerminationReason

      Casesexternally

      • Unknown

        Unknown reason (fallback).

        Value: "Unknown"

      • HeartbeatTimeout

        Node was terminated due to heartbeat timeout.

        Value: "HeartbeatTimeout"

      • Shutdown

        Node was terminated due to graceful shutdown.

        Value: "Shutdown"

cluster_RegisterNode

POST/api/v1/actions/invoke/cluster_RegisterNode

Register a new cluster node.

Request RegisterClusterNodeAction

Fields (JSON object)

  • nameoptional

    Name of the cluster node.

    string

Response RegisterClusterNodeOutput

Fields (JSON object)

  • nodeId(from node_id)required

    ID of the cluster node.

    ClusterNodeIdstring

cluster_ReportNodeHeartbeat

POST/api/v1/actions/invoke/cluster_ReportNodeHeartbeat

Report the heartbeat of a cluster node.

Request ReportClusterNodeHeartbeatAction

No fields.

Response Empty

No fields.

cluster_CleanupInactiveNodes

POST/api/v1/actions/invoke/cluster_CleanupInactiveNodes

Cleanup inactive cluster nodes.

Request CleanupInactiveClusterNodesAction

No fields.

Response Empty

No fields.