Licenses

URL:: https://<system-url>/licenses
Methods:: GET
Required Capability:: Administrator
Version Introduced:: 10.2.1

Description

Portal for ArcGIS requires a valid license to function correctly. This resource returns the current status of the license.

As of 10.2.1, Portal for ArcGIS enforces the license by checking the number of registered members and comparing it with the maximum number of members authorized by the license. Contact Esri Customer Service if you have questions about license levels or expiration properties.

Starting at 10.5, Portal for ArcGIS enforces two levels of membership for licensing to define sets of privileges for registered members and their assigned roles.

Request parameters

Parameter	Details
`f`	The response format. The default response format is `html` . Values: `html` \| `json` \| `pjson`

Example usage

Below is a sample request URL for the licenses resource:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/portaladmin/system/licenses?f=json

JSON Response syntax

Use dark colors for code blocksCopy
{
  "isValid": <true|false>,
  "currentRegisteredMembers": <number>,
  "maximumRegisteredMembers": <number>,
  "expiration": <expiration_value>,
  "features": [  \\Added at 10.5
    {
      "level": "",
      "name": "",
      "displayName": "",
      "isValid": <true|false>,
      "currentRegisteredMembers": <number>,
      "maximumRegisteredMembers": <number>,
      "version": "10.5",
      "expiration": <expiration_value>
    },
    {
      "level": "",
      "name": "",
      "displayName": "",
      "isValid": <true|false>,
      "currentRegisteredMembers": <number>,
      "maximumRegisteredMembers": <number>,
      "version": "10.5",
      "expiration": <expiration_value>
    }
  ]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "isValid": true,
  "currentRegisteredMembers": 25,
  "maximumRegisteredMembers": 100,
  "expiration": 1381820400000,
  "features": [
    {
      "level": "1",
      "name": "esriPortalLvl1",
      "displayName": "Portal for ArcGIS",
      "isValid": true,
      "currentRegisteredMembers": 5,
      "maximumRegisteredMembers": 40,
      "version": "10.5",
      "expiration": 1381820400000
    },
    {
      "level": "2",
      "name": "esriPortalLvl2",
      "displayName": "Portal for ArcGIS",
      "isValid": true,
      "currentRegisteredMembers": 20,
      "maximumRegisteredMembers": 60,
      "version": "10.5",
      "expiration": 1381820400000
    }
  ]
}