Harthelm Docs

The usage report for a renewal

Cluster admins only (`platform.admin`; `hart admin license usage-report`, the console's *Download usage report*). The daily highs of the counted limits since the start of the licence in force (at most a year), with the installation id, the version and the console host: counts only, no names and no email addresses. The installation never sends it anywhere; an admin hands it over at renewal.

Generated from openapi/harthelm.yaml at v1.5.0
GET
/admin/license/usage-report

Authorization

cookie__Host-harthelm_session<token>

Browser session of the UI (12 h idle, 7 days absolute). State-changing requests also need the header Harthelm-CSRF: 1 and a matching Origin.

Response Body

The usage report.

application/json
  1. response
format*string
generated_at*string
Formatdate-time
installation*string
version*string
console_host*string
license?

The licence in force when the report was made.

peak*
days*array<>
curl -X GET 'https://console.example.com/api/v1/admin/license/usage-report'
{  "format": "string",  "generated_at": "2019-08-24T14:15:22Z",  "installation": "string",  "version": "string",  "console_host": "string",  "license": {    "id": "string",    "customer_id": "string",    "customer": "string",    "kind": "string",    "limits": {      "vcpus": 0,      "users": 0,      "workspaces": 0,      "nodes": 0    },    "overage": "string",    "start": "2019-08-24",    "end": "2019-08-24"  },  "peak": {    "vcpus": 0,    "users": 0,    "workspaces": 0,    "nodes": 0  },  "days": [    {      "day": "2019-08-24",      "vcpus": 0,      "users": 0,      "workspaces": 0,      "nodes": 0    }  ]}