×
Menu
Index
Search
 
   
   
   
 

newlicense

 

Description

 
Install a new SoftNAS Cloud® license key.
 
POST newlicense
 

Request

 
Consult section Standard Request Structure,
 

Response

 
The following properties are returned in addition to the Standard Response Structure
 
Property
Description
Note/Data Type
actual-storage-GB
Actual storage in use, measured in gigabytes.
String
actual-expiration
Expiration date of license including grace period.
Date String
capabilities
Internal use only.
String
capacityGB
Licensed maximum capacity in gigabytes.
String
currentkey
License key.
String
Msg
Message appropriate to the request, based on success or failure.
String
expiration
Expiration date of the license.
Date String
gracedays
Number of grace days following license expiration that product continues to operate.
Integer String
graceperiod
If a SoftNAS Cloud® license expires in a production environment, it will enter the grace period. “1” means grace period is in effect.
Boolean String
graceremaining
Amount of days remaining in the grace period, before the grace period expires and SoftNAS Cloud® functionality is impacted.
hardware_id
The hardware ID used for license activation.  On AWS, the instance ID; otherwise, IP address of admin interface.
String
ipmode
IP address mode, how the default IP address used for licensing was assigned  “STATIC” or “DHCP”
String
is_activated
Reports if the license is active or not.  True or False.
Boolean String
is_perpetual
Reports if the license is a perpetual license or not.  True or false.
Boolean String
is_subscription
Reports of the license type is subscription-based (monthly or annual).
Boolean String
istrial
Reports if the product is currently running in trial mode.
Boolean String
license-version
Licensed software version of SoftNAS Cloud®.
String
licensetype
Reports the license type: monthly, annual, subscription, trial etc.
String
maint_expiration
Reports the date at which the maintenance package expires.
Date String
maint_expired
Reports if the status of the maintenance package is expired.  True or False.
Boolean String
model
The license model:  “key” (licensed by key) or “utility”. (Licensed by the hour).
String
platform
Platform on which SoftNAS Cloud® is running, i.e., Amazon Web Services, Microsoft Azure, VMWare vSphere, VMware vCloud Air
String
product-id
SoftNAS Cloud® product ID
String
producttype
SoftNAS Cloud® product type.
String
regname
Registered name – customer name associated with an activated license key.
String
sig
internal use only.
 
status
Reports of the current license is valid.
Possible values: valid license or an error message
String
storage-capacity-GB
Reports total storage capacity applicable to the current license in gigabytes.
String
today
Reports today's date.
Date String
totalstorageGB
Total storage consumed currently by storage pools.
String
valid
True if the license is valid.
Boolean String
 
Example
{
    "result": {
        "data": {
            "actual-storage-GB": 29.8,
            "actual_expiration": "01/26/2014",
            "capabilities": "1:1:2048:01/26/2014:2:1",
            "capacityGB": "2,048 GB",
            "currentkey": "CEAASA-BESNJA-8MEED6-AHAZZN-XHWB8X-A2NUK3",
            "errMsg": "Valid License",
            "expiration": "01/28/2014",
            "gracedays": "2",
            "graceperiod": "0",
            "graceremaining": "2",
            "hardware_id": "i-0b06fe44",
            "hwlock": "",
            "is_activated": true,
            "is_perpetual": false,
            "is_subscription": true,
            "istrial": "1",
            "license-version": "1",
            "licensetype": "TRIAL",
            "maint_expiration": "01/28/2014",
            "maint_expired": false,
            "model": "key",
            "product-id": "1",
            "producttype": "SoftNAS™ Professional Edition",
            "regname": "RBLLC",
            "sig": "1F842C0F",
            "status": "Valid License",
            "storage-capacity-GB": "2048",
            "today": "01/12/2014",
            "totalStorageGB": "30 GB",
            "valid": true
        },
        "msg": "",
        "success": true,
        "total": 30
    },
    "session_id": 11255,
    "success": true
}
Made with help of Dr.Explain
Copyright (c) SoftNAS LLC