Difference between revisions of "REST API:license Resource"

From AgileApps Support Wiki
imported>Aeric
m (Text replace - '<tt><nowiki>https://{domain}/networking' to '<tt>{{platformURL}}')
imported>Aeric
 
Line 8: Line 8:
;Method:GET
;Method:GET


;URI:<tt>{{platformURL}}/rest/license</nowiki></tt>
;URI:<tt>{{platformURL}}/rest/license</tt>


;Response:
;Response:

Latest revision as of 22:04, 30 March 2012

Retrieve Platform License options via the REST API

Requirements

  • You must be logged in as a System Administrator

Get License Info

Method
GET
URI
https://{yourDomain}/networking/rest/license
Response
<platform>
    <license>
        <licenseType>Free </licenseType>
        <validity>182</validity>
        <gracePeriod>0</gracePeriod>
        <licenseServerPort>9898</licenseServerPort>
        <numberOfCPUs>0</numberOfCPUs>
        <installDate>Mon Apr 26 11:36:05 PDT 2010</installDate>
        <expirationDate>Mon Oct 25 11:36:05 PDT 2010</expirationDate>
        <remainingDays>123</remainingDays>
        <hostName>domU-12-31-38-01-AA-11</hostName>
    </license>

    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>

Fields

  • licenseType - Trial or production license
  • validity - number of days the license is valid
  • gracePeriod – number of days in the grace period
  • licenseServerPort – port on which the license server is running
  • numberOfCPUs – number of CPUs under this license
  • installDate – date the license was installed
  • expirationDate – date the license will expire
  • remainingDays – number of days before the license expires
  • hostname – hostname of the server where the license is installed