Skip to end of metadata
Go to start of metadata

Adds a new license to the specified customer.

Production and NFR licenses can be created based on the partner’s permissions.

Method: POST

Fields

Name

Type

Description

INPUT

customer_id (Mandatory)

Integer

This field indicates the Customer ID number

product (Mandatory)

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 (Mandatory)

Integer

This field indicates the product type:

1= Evaluation

2= NFR

3= Production

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_transactions

Integer or empty

This field indicates the maximum number of transactions that are permitted to run in the system

metrics_by_bandwidth

Integer or empty

This field indicates the maximum bandwidth that can be used by the customer

metrics_by_access_points

Integer or empty

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

creation_date

Datetime

This field indicates the license creation date

start_date (Mandatory)

Date

This field indicates the license start date

end_date (Mandatory)

Date

This field indicates the license end date

subscription

Integer or empty

This field indicates the subscription period:

1=monthly auto renewal 2=1 month

3=1 year

4=3 years

Note: You must provide either subscription or expiration date

expiration_date

Date

This field indicates the license expiration date

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 Note: Only installed

available products of the partner

will be available to be configured.

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_transactions

Integer or empty

This field indicates the maximum number of transactions that are permitted to run in the system

metrics_by_bandwidth

Integer or empty

This field indicates the maximum bandwidth that can be used by the customer

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

end_date

Date

This field indicates the license end 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> POST https://<host>/api/licenses/?customer_id=2 product_catalog=31 product_type=2 metrics_by_users=100 start_date="2015-12-01" subscription=3
Response Example
{
    "license_id": 140913,
    "customer_id": 23718,
    "product": 42,
    "product_type": 3,
    "start_date": "2018-12-01",
    "expiration_date": "2020-10-01",
    "creation_date": "2019-02-05 12:11:20",
    "metrics_by_users": 1000,
    "metrics_by_access_points": null,
    "subscription": 3,
    "is_active": true
}
  • No labels