Get List of Entitlements (License Types)

Members Account Licensing API base URL: https://my.interfaceware.com

Get List of Entitlements GET /api

This API method returns a JSON object containing a list of license types and select the ID for the type you want to activate.

Parameters:

Parameter	Description	Value (as a string)

Parameter	Description	Value (as a string)
product	The product you want licenses for.	`IguanaX`
token	Your authentication token from Get an Authentication Token	`<token>`
method	The API method name.	`license.listentitlements`

Sample Request:

Curl request calling the API and parsing the selected license entitlement id from the response:

LicenseName="IguanaX Test" #change to name of license type to activate
EntitlementID=`curl -k -X POST "https://my.interfaceware.com/api?method=license.listentitlements&product=IguanaX&token=<IguanaToken>" | jq -r --arg name "$LicenseName" '.data[] | select(.name==$name) | .id'`

Response:

{
    "data": [
        {
            "entitlements_total": "3",
            "name": "IguanaX Dev",
            "num_components": "50",
            "id": "1",
            "entitlements_used": "1",
            "license_expiry": "0",
            "log_search": "365"
        },
        {
            "entitlements_total": "3",
            "name": "IguanaX Test",
            "num_components": "50",
            "id": "2",
            "entitlements_used": "1",
            "license_expiry": "0",
            "log_search": "365"
        },
        {
            "entitlements_total": "3",
            "name": "Iguana X Prod",
            "num_components": "50",
            "id": "3",
            "entitlements_used": "1",
            "license_expiry": "0",
            "log_search": "365"
        },
    ],
    "status": "ok"
}

IguanaX Documentation

Get List of Entitlements (License Types)

Analytics

Related content