Licenses

URL:: https://<root>/system/licenses
Methods:: GET
Version Introduced:: 10.1

Access requirements

Required privileges

The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.

Register data stores Feature layer Update Delete Security and infrastructure Servers Organization webhooks Geoprocessing Publisher role

Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.

Learn how to generate a token

Description

The licenses resource lists the current license level of ArcGIS Server and all authorized extensions.

Request parameters

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

Example usage

The following is a sample request URL used to access the licenses resource:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/system/licenses?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
  "edition": {
    "name": "<edition>",
    "version": "<version>",
    "canExpire": true|false,
    "expiration": <expiration> //MILLISECONDS SINCE EPOCH
  },
  "level":   {
    "name": "<level>",
    "version": "<version>",
    "canExpire": true|false,
    "expiration": <expiration> //MILLISECONDS SINCE EPOCH
  },
  "datafeature": {
    "name": "<feature>",
    "version": "<version>",
    "canExpire": true|false,
    "expiration": <expiration> //MILLISECONDS SINCE EPOCH
  },
  "extensions": [
    {
      "name": "<extension>",
      "version": "<version>",
      "canExpire": true|false,
      "expiration": <expiration>, //MILLISECONDS SINCE EPOCH
      "appid": "<ID>"
    }
  ],
  "features":	[		//Added at 10.5
    {
      "name": "<feature/role>",
      "displayName": "<displayName>",
      "coreCount": <coreCount>,
      "version": "<version>",
      "canExpire": true|false,
      "expiration": <expiration>, //MILLISECONDS SINCE EPOCH
    }
  ]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "edition": {
    "name": "svradvanced",
    "version": "10.5",
    "canExpire": true,
    "expiration": 1322553600000
    "featureName": "esriServerLicenseAdvanced" 	//Added at 10.5
  },
  "level": {
    "name": "svrenterprise",
    "version": "10.5",
    "canExpire": true,
    "expiration": 1322553600000
  },
  "datafeature": {
    "name": "arcsdeserver",
    "version": "10.5",
    "canExpire": true,
    "expiration": 1322553600000
    "ecpCode": "ecp000000000"
  },
  "extensions": [
    {
       "name": "interopserver",
       "version": "10.5",
       "canExpire": true,
       "expiration": 1322553600000
    },
    {
       "name": "highwayssvr",
       "version": "10.5",
       "canExpire": true,
       "expiration": 1322553600000
    },
    {
       "name": "networkserver",
       "version": "10.5",
       "canExpire": true,
       "expiration": 1322553600000
    }
  ],
  "features": [				//Added at 10.5
    {
       "name": "esriServerLicenseAdvanced",
       "displayName": "ArcGIS Server Advanced Core",
       "coreCount": 4,
       "version": "10.5",
       "canExpire": true,
       "expiration": 1322553600000
    },
    {
       "name": "esriServerSDEEnterprise",
       "displayName": "SDE Enterprise Core",
       "coreCount": 0,
       "version": "10.5",
       "canExpire": true,
       "expiration": 1322553600000
    },
    {
       "name": "esriServerInterop",
       "displayName": "Data Interoperability Extension for ArcGIS Server",
       "coreCount": 0,
       "version": "10.5",
       "canExpire": true,
       "expiration": 1322553600000
    },
    {
       "name": "esriServerHighways",
       "displayName": "Esri Roads and Highways for ArcGIS Server",
       "coreCount": 0,
       "version": "10.5",
       "canExpire": true,
       "expiration": 1322553600000
    },
    {
       "name": "esriServerNetwork",
       "displayName": "Network Analyst Extension for ArcGIS Server",
       "coreCount": 0,
       "version": "10.5",
       "canExpire": true,
       "expiration": 1322553600000
    }
  ]
}