Enterprise Recon v1 API

All Documentation > ER2 v1 API > Licenses

Licenses

Information about ER2 licenses.

Get License Details

Get detailed information for all available licenses for current installation of ER2. User can choose to search for license information for a specific Target.

Request

GET

https://er-master:8339/v1/licenses

Authorization

Basic Authentication

Query Parameters

Parameter	Data Type	Description
target_name	string example: target_name=Example.com	Filter license information by Target name.

Parameter

Data Type

Description

target_name

string

example: target_name=Example.com

Filter license information by Target name.

Header Parameters

Parameter	Data Type	Description
Accept-Encoding	string enum: gzip deflate	Specify the compression algorithm to use on the response object. Compressed content will not be returned for endpoints that return reports as files (e.g. PDF, CSV etc), endpoints that return binary files (e.g. Node Agent installers) or unsuccessful API calls.

Parameter

Data Type

Description

Accept-Encoding

string

enum: gzip deflate

Specify the compression algorithm to use on the response object.
Compressed content will not be returned for endpoints that return reports as files (e.g. PDF, CSV etc), endpoints that return binary files (e.g. Node Agent installers) or unsuccessful API calls.

Request Samples

HTTP

GET /v1/licenses
Accept: application/json

cURL

curl --request GET 'https://er-master:8339/v1/licenses' \
--user apiuser:password123 \
--header "Accept: application/json"

Response Schema

200 OK

Response Item	Data Type	Description
state	string enum: licensed expired exceeded absent	Current ER2 system state.
expires	number	License expiration date in Unix time format.
edition	string enum: PCI PII PRO NOW	Licensed Enterprise Recon edition.
company	string	Name of the company or organization that the ER2 license is registered to.
targets	object	A list of Targets and the assigned license pool information. Not returned for Sitewide licensing model.
targets/name	string	Licensed Target name.
targets/id	string	Unique Target ID. This ID is unique 20 digit number.
targets/type	string	The Target type license pool from which the Target is assigned a license. The summary provides more detailed information on each Target license pool.
summary	object	Details on data allowance license.
summary/type	string enum: server workstation microsoft google dropbox hadoop box amazon azure rackspace lotus imap teradata tibero sharepoint spo informix mongodb global serverdata userdata	Describes the Target license pool.
summary/comment	string enum: Server Workstation Office 365/Exchange User Google Apps User Dropbox User Hadoop Data Allowance Box User Amazon S3 Bucket Azure Queue/Table/BLOB Rackspace Cloud User Lotus Notes User IMAP User Teradata Data Allowance Tibero Data Allowance SharePoint Server Data Allowance SharePoint Online Data Allowance IBM Informix Data Allowance Global Data Allowance Server Data Allowance User Data Allowance	Detailed description for the License pool.
summary/total	integer	Dependent on Target licensing model. Total number of licenses from the license pool, total data allowance limit for a given Target type, or total data allowance limit for a given data allowance pool.
summary/usage	integer	Dependent on Target licensing model. Number of assigned licenses from the license pool, consumed data allowance for a given Target type, or consumed data allowance for a given data allowance pool.
datausage	object	Details on data allowance license.
datausage/id	string	Location ID. Not returned for Sitewide licensing model.
datausage/location	string	Description of Target, Target location, or scan root for which the data usage is calculated.
datausage/type	string enum: informix teradata tibero hadoop sharepoint spo serverdata userdata	The Target type or license pool from which the Target is assigned a license.
datausage/bytes	number <bytes>	Total amount of data allowance consumed for the corresponding Target, Target location or scan root.
datausage/attribution	string enum: global server client	Indicates the data allowance pool from which the Target consumes data.
warning	string	Detailed information on the number of scans and the amount of scan data that have not been processed. Only applicable if there are unprocessed scans and the Master Server license has expired, or the license limit has been exceeded.

Response Samples

Legacy Target licensing model.

200 OK

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
{
  "company": "My Company Pte Ltd",
  "expires": 1636962676,
  "targets": [
    {
      "name": "MY-WINDOWS-MACHINE",
      "id": "1563630061562709112",
      "type": "server"
    },
    {
      "name": "CENTOS-ER2026",
      "id": "2047655813564067948",
      "type": "server"
    },
    {
      "name": "microsoft@User Name",
      "id": "2377014395958949453",
      "type": "microsoft"
    },
    {
      "name": "FREEBSD-ER2",
      "id": "4759598330602895744",
      "type": "server"
    },
    {
      "name": "MY-CPU-10",
      "id": "5776191921548943090",
      "type": "server"
    },
    {
      "name": "dropbox@USER@EXAMPLE.COM",
      "id": "7509655433083541934",
      "type": "dropbox"
    },
    {
      "name": "OPENSUSE-ER2026",
      "id": "9901361528024664429",
      "type": "server"
    },
    {
      "name": "DROPBOX:USER@EXAMPLE.COM",
      "id": "10962094962201651950",
      "type": "none"
    }
  ],
  "summary": [
    {
      "type": "server",
      "comment": "Server",
      "total": "20",
      "usage": "5"
    },
    {
      "type": "workstation",
      "comment": "Workstation",
      "total": "20",
      "usage": "0"
    },
    {
      "type": "microsoft",
      "comment": "Office 365/Exchange User",
      "total": "20",
      "usage": "1"
    },
    {
      "type": "google",
      "comment": "Google Apps User",
      "total": "20",
      "usage": "0"
    },
    {
      "type": "dropbox",
      "comment": "Dropbox User",
      "total": "20",
      "usage": "1"
    },
    {
      "type": "box",
      "comment": "Box User",
      "total": "20",
      "usage": "0"
    },
    {
      "type": "amazon",
      "comment": "Amazon S3 Bucket",
      "total": "20",
      "usage": "0"
    },
    {
      "type": "azure",
      "comment": "Azure Queue/Table/BLOB",
      "total": "20",
      "usage": "0"
    },
    {
      "type": "rackspace",
      "comment": "Rackspace Cloud User",
      "total": "20",
      "usage": "0"
    },
    {
      "type": "lotus",
      "comment": "Lotus Notes User",
      "total": "20",
      "usage": "0"
    },
    {
      "type": "imap",
      "comment": "IMAP User",
      "total": "20",
      "usage": "0"
    },
    {
      "type": "teradata",
      "comment": "Teradata Data Allowance",
      "total": "20000000000000",
      "usage": "0"
    }
  ]
}

Sitewide Target licensing model.

200 OK

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
{
    "state": "exceeded",
    "expires": "1938048757",
    "edition": "PII",
    "company": "My Organization Inc",
    "summary": [
        {
            "type": "global",
            "comment": "Global Data Allowance",
            "total": "1000000000",
            "usage": "1157499270"
        }
    ],
    "datausage": [
        {
            "type": "file",           
            "location": "MY-WINDOWS-MACHINE/D:\\Important",
            "bytes": "21513313",
            "attribution": "global"
        },
        {
            "type": "file",          
            "location": "MY-WINDOWS-MACHINE/D:\\My-Data\\my-doc.pdf",
            "bytes": "4832448",
            "attribution": "global"
        },
        {
            "type": "file",          
            "location": "MY-WINDOWS-MACHINE/D:\\My-Data\\my-folder.zip",
            "bytes": "4829456",
            "attribution": "global"
        },
        {
            "type": "file",          
            "location": "MY-WINDOWS-MACHINE/D:\\My-Data\\table9.csv",
            "bytes": "432709",
            "attribution": "global"
        },
        {
            "type": "file",          
            "location": "MY-WINDOWS-MACHINE/D:\\My-Data\\Project-01",
            "bytes": "11410212",
            "attribution": "global"
        },
        {
            "type": "file",          
            "location": "MY-WINDOWS-MACHINE/D:\\My-Data\\Project-02",
            "bytes": "23688842",
            "attribution": "global"
        },
        {
            "type": "file",          
            "location": "MY-WINDOWS-MACHINE/D:\\My-Data\\Project-03",
            "bytes": "47338714",
            "attribution": "global"
        },
        {
            "type": "file",          
            "location": "MY-WINDOWS-MACHINE/D:\\My-Data\\Project-04",
            "bytes": "94859416",
            "attribution": "global"
        },
        {
            "type": "file",          
            "location": "MY-WINDOWS-MACHINE/D:\\My-Data\\Project-05",
            "bytes": "189718832",
            "attribution": "global"
        },
        {
            "type": "file",          
            "location": "MY-WINDOWS-MACHINE/D:\\My-Data\\Project-06",
            "bytes": "758875328",
            "attribution": "global"
        }
    ],
    "warning": "85567564053 bytes of scanned data from 2 scans pending processing"
}

Non-Sitewide Target licensing model.

200 OK

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: xxx
{
  "state": "licensed",
  "expires": "1632378566",
  "edition": "PRO",
  "company": "Example Company Inc",
  "summary": [
    {
      "type": "server",
      "comment": "Server",
      "total": "5",
      "usage": "1"
    },
    {
      "type": "client",
      "comment": "Client",
      "total": "5",
      "usage": "1"
    },
    {
      "type": "server",
      "comment": "Server Data Allowance",
      "total": "50000000000",
      "usage": "2347137973"
    },
    {
      "type": "client",
      "comment": "Client Data Allowance",
      "total": "50000000000",
      "usage": "1966126249"
    }
  ],
  "targets": [
    {
      "name": "MY-WINDOWS-MACHINE",
      "id": "15192847076812295797",
      "type": "workstation"
    },
    {
      "name": "MY-UBUNTU-MACHINE",
      "id": "15752461946507620351",
      "type": "server"
    }
  ],
  "datausage": [
    {
      "type": "file",           
      "location": "MY-WINDOWS-MACHINE All local files",
      "bytes": "21513313",
      "attribution": "client"
    },
    {
      "type": "file",
      "location": "MY-UBUNTU-MACHINE All local files",
      "bytes": "2347137973",
      "attribution": "server"
    }
  ]
}

Upload License File

Upload a new license file for ER2 Master Server and Targets.

Request

PUT

https://er-master:8339/v1/licenses

Authorization

Basic Authentication

Request Schema

Response Item	Data Type	Description
content	string	Contents of the ER2 license file. String must be in Base64 encoding format.

Request Samples

HTTP

PUT /v1/licenses
Content-Type: application/json
{
  "content": "NUE1REU1MTk3ODRBRDU1NEMxNDZGOTAwMw=="
}

cURL

curl --request PUT 'https://er-master:8339/v1/licenses' \
--user apiuser:password123 \
--header "Content-Type: application/json" \
--data-raw '{
    "content": "NUE1REU1MTk3ODRBRDU1NEMxNDZGOTAwMw=="
}'

Response Samples

204 No Content

422 Unprocessable Entity

Returned if attempting to upload an ER2 license file that has been previously uploaded.

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: xxx
{
  "message": "License upload failed: The license has already been used. Each license can only be uploaded once."
}

Returned if attempting to upload an invalid ER2 license file.

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: xxx
{
  "message": "Invalid license file."
}

Returned if attempting to upload an expired ER2 license file.

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: xxx
{
  "message": "License is expired."
}

Returned if attempting to upload a valid ER2 license file with a smaller data allowance limit than the already-consumed data.

HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json
Content-Length: xxx
{
  "message": "Insufficient data allowance for scanned data volume."
}