license

croit license information.

GET /license

Parameters

No parameters...

Endpoint

curl -X GET http://mgmt-node:8080/api/license
                

Response 200

license
object
optional
-
currentUsage
object
optional
Current cluster usage for licensing purposes.
message
string
optional
Informational message with license details, e.g., a reason why it is invalid
email
string
optional
Configured email address for license notifications.
active
boolean
optional
Whether the license is active
registered
boolean
optional
Whether the cluster is registered with portal.croit.io

Example response

{
  "license": {
    "fsid": "string",
    "croitId": "string",
    "licenseId": "string",
    "validUntil": 0,
    "nextRefresh": 0,
    "licenseRestrictions": {
      "nextRefresh": 0,
      "cephUuid": "string",
      "gracePeriodDays": 0,
      "features": {},
      "osds": {
        "total": 0,
        "hdd": 0,
        "ssd": 0,
        "nvme": 0,
        "unknown": 0,
        "gracePercent": 0
      },
      "rawCapacityGb": {
        "total": 0,
        "hdd": 0,
        "ssd": 0,
        "nvme": 0,
        "unknown": 0,
        "gracePercent": 0
      },
      "usedCapacityGb": {
        "total": 0,
        "hdd": 0,
        "ssd": 0,
        "nvme": 0,
        "unknown": 0,
        "gracePercent": 0
      },
      "netCapacityGb": {
        "total": 0,
        "hdd": 0,
        "ssd": 0,
        "nvme": 0,
        "unknown": 0,
        "gracePercent": 0
      }
    },
    "registered": true
  },
  "currentUsage": {
    "osds": {
      "total": 0,
      "hdd": 0,
      "ssd": 0,
      "nvme": 0,
      "unknown": 0,
      "gracePercent": 0
    },
    "rawCapacityGb": {
      "total": 0,
      "hdd": 0,
      "ssd": 0,
      "nvme": 0,
      "unknown": 0,
      "gracePercent": 0
    },
    "usedCapacityGb": {
      "total": 0,
      "hdd": 0,
      "ssd": 0,
      "nvme": 0,
      "unknown": 0,
      "gracePercent": 0
    },
    "netUsageGb": {
      "total": 0,
      "hdd": 0,
      "ssd": 0,
      "nvme": 0,
      "unknown": 0,
      "gracePercent": 0
    }
  },
  "message": "string",
  "email": "string",
  "active": true,
  "registered": true
}
                  

PATCH /license/license

Parameters

body
object
optional
-

Endpoint

curl -X PATCH http://mgmt-node:8080/api/license/license
                

Example body

{
  "email": "string"
}
                

POST /license/refresh

Parameters

No parameters...

Endpoint

curl -X POST http://mgmt-node:8080/api/license/refresh
                

Response 200

license
object
optional
-
currentUsage
object
optional
Current cluster usage for licensing purposes.
message
string
optional
Informational message with license details, e.g., a reason why it is invalid
email
string
optional
Configured email address for license notifications.
active
boolean
optional
Whether the license is active
registered
boolean
optional
Whether the cluster is registered with portal.croit.io

Example response

{
  "license": {
    "fsid": "string",
    "croitId": "string",
    "licenseId": "string",
    "validUntil": 0,
    "nextRefresh": 0,
    "licenseRestrictions": {
      "nextRefresh": 0,
      "cephUuid": "string",
      "gracePeriodDays": 0,
      "features": {},
      "osds": {
        "total": 0,
        "hdd": 0,
        "ssd": 0,
        "nvme": 0,
        "unknown": 0,
        "gracePercent": 0
      },
      "rawCapacityGb": {
        "total": 0,
        "hdd": 0,
        "ssd": 0,
        "nvme": 0,
        "unknown": 0,
        "gracePercent": 0
      },
      "usedCapacityGb": {
        "total": 0,
        "hdd": 0,
        "ssd": 0,
        "nvme": 0,
        "unknown": 0,
        "gracePercent": 0
      },
      "netCapacityGb": {
        "total": 0,
        "hdd": 0,
        "ssd": 0,
        "nvme": 0,
        "unknown": 0,
        "gracePercent": 0
      }
    },
    "registered": true
  },
  "currentUsage": {
    "osds": {
      "total": 0,
      "hdd": 0,
      "ssd": 0,
      "nvme": 0,
      "unknown": 0,
      "gracePercent": 0
    },
    "rawCapacityGb": {
      "total": 0,
      "hdd": 0,
      "ssd": 0,
      "nvme": 0,
      "unknown": 0,
      "gracePercent": 0
    },
    "usedCapacityGb": {
      "total": 0,
      "hdd": 0,
      "ssd": 0,
      "nvme": 0,
      "unknown": 0,
      "gracePercent": 0
    },
    "netUsageGb": {
      "total": 0,
      "hdd": 0,
      "ssd": 0,
      "nvme": 0,
      "unknown": 0,
      "gracePercent": 0
    }
  },
  "message": "string",
  "email": "string",
  "active": true,
  "registered": true
}