1. Cluster Management
Peladen
  • Peladen
    • Welcome to Peladen
  • Cluster Management
    • Create Your First Cluster
    • Cluster Management
      • Register Node
        POST
      • Configure Node
        POST
      • Unregister Node
        POST
      • Get Node Metrics
        GET
      • Get Cluster Usage
        GET
  • Database Management
    • Database Management
      • Provision Database
      • Suspend Database
      • Teardown Database
      • Database Metering
  • Object Storage Management
    • Storage: Daily Operation
      • Generate Upload URL
      • Generate Download URL
      • Delete File
      • Get End User Usage
    • Storage: Admin Management
      • Configure Storage Backend
      • Storage Status
      • Storage Usage
      • Update End User Quota
  1. Cluster Management

Get Cluster Usage

Sandbox Env
https://api-sandbox.usepeladen.com/api/v1/cluster
Sandbox Env
https://api-sandbox.usepeladen.com/api/v1/cluster
GET
/api/v1/cluster/usage/{end_user_id}
Retrieve overall usage and health statistics for a user's cluster. Can be used for billing reference.

Request

Path Params

Responses

🟢200
application/json
Body

🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api-sandbox.usepeladen.com/api/v1/cluster/api/v1/cluster/usage/'
Response Response Example
200 - Example 1
{
    "end_user_id": "string",
    "cluster_id": "string",
    "total_nodes": 0,
    "active_nodes": 0,
    "health": "string",
    "nodes": [
        {
            "node_id": "string",
            "name": "string",
            "status": "string",
            "last_seen": null
        }
    ]
}
Modified at 2026-03-21 13:13:00
Previous
Get Node Metrics
Next
Provision Database
Built with