Skip to end of metadata
Go to start of metadata

Returns the licenses information for the specified customer_id.

Method: GET

Fields

Name

Type

Description

INPUT

customer_id (Mandatory)

Integer

This field indicates the customer ID number

OUTPUT

license_id

Integer

This field indicates the License ID number

customer_id

Integer

This field indicates the customer ID number

product

Integer

This field indicates the product:

1=Web Security Public/Guest Networks - DNS only

11=Web Security Public/Guest Networks-DNS & HTTP

21=Web Security Standard

31=Web Security Plus
Only installed available_products of the partner will be available to be configured.

41=Web Security Advanced

42=DNS security

Email:

43=Email Security Standard

46=Email Security Standard with Outbound

44=Email Security Plus

45=Email Archiving


product_type

Integer

This field indicates the product type:

1= Evaluation

2= Production

3= NFR

subscription

Integer or empty

This field indicates the subscription period:

1=(monthly auto renewal) 2=(1 month)

3=(1 years)

4=(3 years)

metrics_by_users

Integer or empty

This field indicates the maximum number of users that can use the product. Empty value indicates an unlimited users

metrics_by_access_points

Integer or empty

This field indicates the maximum access points that can be used by the customer

start_date

Date

This field indicates the start date of the license

expiration_date

Date

This field indicates the license expiration date

creation_date

Datetime

This field indicates the license creation date

is_active

Boolean

This field indicates if the license is active. Only one license can be active for the customer.  True=active, False=not active

Request Example
http -a <admin_email>:<admin_password> GET https://<host>/api/licenses/?customer_id=1
Response Example
 Code:  200 OK
Content: [{
"license_id": 600,
"product": 31,
"product_type": 2,
"metrics_by_users": 100,
"metrics_by_transactions": null,
"metrics_by_bandwidth": null,
"metrics_by_access_points":null,
"start_date": "2015-12-01",
"subscription": 3,
"expiration_date": "2016-12-01",
"creation_date": "2016-01-11 08:23:34",
"is_active": true
}]
  • No labels