**Licenses** ====================== **Generate a License** +++++++++++++++++++++++ .. http:post:: /_config/licenses **Description** This is used for generating new license. **HTTP Method** POST **Endpoint:** ``/_config/licenses`` **Request Header** ``Authorization`` `Basic ` **Request Parameters** Body Parameters - ``license_name`` (string, *required*): The name of the license to be created. - ``plant_id`` (string, *required*): The ID of the plant against which the license is to be generated. - ``site_id`` (string, *required*): The ID of the site against which the license is to be generated. - ``license_validity`` (string, *required*): licen se validity in days/months or year. - ``app`` (string, *required*): The name of the application against which the license is to be generated. - ``license_quota`` (string, *optional*): The quota of the monitors to be managed. - ``license_description`` (string, *optional*): The description of the license like who issued it or who will be using it and so on. **Sample Request** .. code-block:: sh curl --location 'https://app.4pointx.com/_config/licenses' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic ' \ --data '{ "license_name":"L1", "plant_id": "7a45d8sde5-92d2-46a7-92d3-85aa4bd57bba", "site_id": "4230adcbawd-f349-4780-bf79-4a8c94a3b13b", "license_validity": "1y", "app":"EMS", "license_quota": "100", "license_description": "Description" }' **Sample Response** Success .. sourcecode:: json { "id": "96978782-b0ea-49dc-9f87-2edf8ba2f126" } Error .. sourcecode:: json { "error": { "status": 400, "message": "Invalid Content Type" } } .. sourcecode:: json { "error": { "status": 400, "message": "Insufficient Inputs" } } .. sourcecode:: json { "error": { "status": 403, "message": "Not authorised" } } **Update License** ++++++++++++++++++++++++ .. http:put:: /_config/licenses/ **Description** This endpoint allows you to update the details of a specific license by providing its ID. **HTTP Method** PUT **Endpoint** ``/_config/licenses/`` **Request Header** ``Authorization`` `Basic ` **Request Parameters** Body Parameters - ``license_name`` (string, *optional*): The updated license name. - ``plant_id`` (string, *optional*): The updated name of the plant id. - ``site_id`` (string, *optional*): The updated name of the site id. - ``license_description`` (string, *optional*): The updated license description. - ``license_validity`` (string, *optional*): The updated license validity. - ``app`` (string, *optional*): The updated name of the application. - ``license_quota`` (string, *optional*): The updated license quota. - ``license_description`` (string, *optional*): The updated license description. - ``status`` (string, *optional*): The updated status. URL Parameters - ``license_id`` (string, *required*): The ID of the license to be updated. **Sample Request** .. code-block:: sh curl --location --request PUT 'https://app.4pointx.com/_config/licenses/96978782-b0ea-49dc-9f87-2edf8ba2f126' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic YWRtaW46clpvcGN1S3FVSXFteXJPVUNibDVTZGx4bVQzYU55ZG0=' \ --data ' { "license_name":"L1", "plant_id": "7a45d8sde5-92d2-46a7-92d3-85aa4bd57bba", "site_id": "4230adcbawd-f349-4780-bf79-4a8c94a3b13b", "license_validity": "1y", "app":"EMS", "license_quota": "100", "license_description": "Description" }' **Sample Response** Success .. sourcecode:: json "license Updated" Error .. sourcecode:: json { "error":{ "status": 400, "message": "Invalid Content Type" } } .. sourcecode:: json { "error":{ "status": 400, "message": "Insufficient Inputs" } } .. sourcecode:: json { "error":{ "status": 403, "message": "not authorised" } } .. sourcecode:: json { "error":{ "status": 400, "message": "Invalid license" } } **Get License** +++++++++++++++++++++++ .. http:get:: /_config/licenses/ **Description** This endpoint allows you to retrieve details about a specific license by providing its license_id. **HTTP Method** GET **Endpoint** ``/_config/licenses/`` **Request Header** ``Authorization`` `Basic ` **Request Parameters** URL Parameters - ``license_id`` (string, *required*): The license id of the license to be retrieved. **Sample Request** .. code-block:: sh curl --location 'https://app.4pointx.com/_config/licenses/96978782-b0ea-49dc-9f87-2edf8ba2f126' \ --header 'Authorization: Basic ' **Sample Response** Success .. code-block:: json { "license_id": "f3567a6a-8b57-4ae5-9584-b11dd8926c79", "license_key": ">+oV]G7IV%syFP49NizdKvx?yx19RYoP", "license_name": "t1", "plant_id": "7a45d8e5-92d2-46a7-92d3-85aa4bd57bba", "site_id": "4230adcb-f349-4780-bf79-4a8c94a3b13b", "created_at": 1709701645, "activated_at": 1709708778, "license_validity": "1y", "expiry_date": 1741244778, "app": "EMS", "license_quota": "200", "status": "Active", "license_description": "hello", "license_used": 30 } Error .. sourcecode:: json { "error": { "status": 405, "message": "Method not allowed" } } .. sourcecode:: json { "error": { "status": 400, "message": "Data not found" } } .. sourcecode:: json { "error": { "status": 403, "message": "Not Authorised" } } **Fetch List of Licenses** +++++++++++++++++++++++++++++ .. http:GET:: /_config/licenses/_list/ **Description** This endpoint allows you to retrieve a list of all licenses under given site and plant id. **HTTP Method** GET **Endpoint** ``/_config/licenses/_list/`` **Request Header** ``Authorization`` `Basic ` **Request Parameters** Query Parameters - ``site_id`` (string, *required*): The ID of the site for which you want to list licenses. - ``plant_id`` (string, *required*): The ID of the plant for which you want to list licenses. **Sample Request** .. code-block:: sh curl --location ' https://app.4pointx.com/_config/licenses/_list?site_id=3c6ebc96-c2bf-423d-942c-6c937007c00b&plant_id=edcafba2-8d51-47b6-b1a3-07c12b927a51' \ --header 'Authorization: Basic ' \ --data '' **Sample Response** Success .. code-block:: json [ { "license_id": "989eeb51-478d-444f-b5e7-eff79a4f3372", "license_key": "WsMQh$a)yvso]afY9M5TQCLK@NVT50@n", "license_name": "test_ut_plant_ems_license", "plant_id": "edcafba2-8d51-47b6-b1a3-07c12b927a51", "site_id": "3c6ebc96-c2bf-423d-942c-6c937007c00b", "created_at": 1724055006, "activated_at": 1724681092, "license_validity": "12m", "expiry_date": 1755785092, "app": "EMS", "license_quota": 100, "status": "Active", "license_description": "", "latest": true, "license_used": 2, }, { "license_id": "762e6899-0553-4f0b-9d44-38e6210c75c2", "license_key": "Npk2Qt98H(V[=bI}Sde374hgJ=blb9OI", "license_name": "test_ut_plant_cbm_license", "plant_id": "edcafba2-8d51-47b6-b1a3-07c12b927a51", "site_id": "3c6ebc96-c2bf-423d-942c-6c937007c00b", "created_at": 1724055036, "activated_at": 1724681064, "license_validity": "12m", "expiry_date": 1728380655, "app": "CBM", "license_quota": 100, "status": "Active", "license_description": "", "latest": true, "license_used": 5, }, { "license_id": "948d3e09-9d9a-4dce-b314-db499750f658", "license_key": "U=6MYnl7hIxEG&*mhpS4(5tOUN8uazc8", "license_name": "license_new_testing", "plant_id": "edcafba2-8d51-47b6-b1a3-07c12b927a51", "site_id": "3c6ebc96-c2bf-423d-942c-6c937007c00b", "created_at": 1727770523, "activated_at": null, "license_validity": "12m", "expiry_date": null, "app": "EMS", "license_quota": 100, "status": "inactive", "license_description": "license_new", "latest": false, "license_used": 2, } ] Error .. sourcecode:: json { "error": { "status": 400, "message": "Required set of parameters are unavailable" } } .. sourcecode:: json { "error": { "status": 403, "message": "Not Authorised" } } .. sourcecode:: json { "error": { "status": 400, "message": "Insufficient Inputs" } } **Activate Licenses** +++++++++++++++++++++++++++++ .. http:PUT:: /_config/licenses/_activate **Description** This endpoint allows you to activate a new license. It also deactivates an existing license before activating a new license if required. **HTTP Method** PUT **Endpoint** ``/_config/licenses/_activate`` **Request Header** ``Authorization`` `Basic ` **Request Parameters** Body Parameters - ``license_key`` (string, *required*): The license key of the license to be activated. - ``deactivate`` (string, *optional*): The user can proceed to deactivate an existing license and then activate the new one if this parameter is passed along with license_key with "yes" as its value. **Sample Request** - **Case 1: Passing only license_key** .. code-block:: sh curl --location 'https://app.4pointx.com/_config/licenses/_activate' \ --header 'Authorization: Basic ' \ --data '{ "license_key": "9[uY@]WT@zvoasdas?NweOZSBr2A8*ELr%t%" }' - **Case 2: Passing license_key along with deactivate="yes"** .. code-block:: sh curl --location 'https://app.4pointx.com/_config/licenses/_activate' \ --header 'Authorization: Basic ' \ --data '{ "license_key": "9[uY@]WT@zvoasdas?NweOZSBr2A8*ELr%t%", "deactivate": "yes" }' **Sample Response** Success .. sourcecode:: json { "License has been activated successfully" } Error .. sourcecode:: json { "error":{ "status": 400, "message": "Insufficient Inputs" } } .. sourcecode:: json { "error":{ "status": 403, "message": "Not Authorised" } } .. sourcecode:: json { "error":{ "status": 400, "message": "License does not exist" } } .. sourcecode:: json { "error":{ "status": 400, "message": "License either in-use/expired/revoked" } } .. sourcecode:: json { "error":{ "status": 500, "message": "License has been not been activated successfully" } } .. sourcecode:: json { "error":{ "status": 409, "message": "Unable to activate the license as the current monitor count (200) exceeds the permitted quota (150)." "To proceed, please delete the excess monitors, or reach out to your Administrator to raise the quota." } } .. sourcecode:: json { "error": { "status": 202, "message": { "app_name": "EMS", "current_active_license": { "name": "latest_ems_license", "quota": "200", "expiry_date": "24/10/2025" }, "new_license": { "name": "new test ems", "quota": "200", "expiry_date": "20/11/2036" } } } } **Get Notification** +++++++++++++++++++++++ .. http:get:: /_config/licenses/_notification **Description** This endpoint allows user to be notified if a license is about to expire. **HTTP Method** GET **Endpoint** ``/_config/licenses/_notification`` **Request Header** ``Authorization`` `Basic ` Query Parameters - ``site_id`` (string, *optional*): The ID of the site for which you want to trigger Notification. - ``plant_id`` (string, *optional*): The ID of the plant for which you want to trigger Notification. - ``app`` (string, *optional*): The name of app for which you want to trigger Notification. .. note:: - Parameter "app" currently takes values CBM,EMS and LM(License Management) to trigger individual app notification and notification for all in case of LM. **Sample Request** - **Case 1: No input parameters** .. code-block:: sh curl --location 'https://app.4pointx.com/_config/_notification/' \ --header 'Authorization: Basic ' - **Case 2: With input parameters site_id,plant_id and app** .. code-block:: sh curl --location 'https://app.4pointx.com/site_id=3c6ebc96-c2bf-423d-942c-6c937007c00b&plant_id=edcafba2-8d51-47b6-b1a3-07c12b927a51&app=CBM' \ --header 'Authorization: Basic ' **Sample Response** Success - **Case 1: No input parameters** .. sourcecode:: json { "notification":"" } .. sourcecode:: json { "notification":"The EMS license for PLTCM plant is about to expire." } .. sourcecode:: json { "notification": "The CBM license for PLTCM plant is about to expire." } - **Case 2: With input parameters site_id,plant_id and app** .. sourcecode:: json { "notification": [ "The CBM license has expired on Dec 04 2024. Please contact your Administrator to renew your license.", "The EMS license is about to expire on Dec 14 2024. Please contact your Administrator to renew your license." ], "site_id": "3c6ebc96-c2bf-423d-942c-6c937007c00b", "plant_id": "edcafba2-8d51-47b6-b1a3-07c12b927a51", "app": "LM" } .. sourcecode:: json { "notification": [ "The CBM license has expired on Dec 04 2024. Please contact your Administrator to renew your license." ], "site_id": "3c6ebc96-c2bf-423d-942c-6c937007c00b", "plant_id": "edcafba2-8d51-47b6-b1a3-07c12b927a51", "app": "CBM" } Error .. sourcecode:: json { "error": { "status": 400, "message": "Unauthorized" } } .. sourcecode:: json { "error": { "status": 403, "message": "Admin user" } } **Verify App Access** +++++++++++++++++++++++ .. http:get:: /_config/licenses/_verify **Description** This endpoint is used to Verify App Access. **HTTP Method** GET **Endpoint** ``/_config/licenses/_verify`` **Request Header** ``Authorization`` `Basic ` **Request Parameters** Query Parameters - ``app`` (string, *required*): The name of app for which you want to verify user access. .. note:: - This API is strictly internal, operating within the confines of the VM, and are inaccessible to any user/external parties. **Sample Request** .. code-block:: sh curl --location 'https://app.4pointx.com/_config/licenses/_verify?app=LM' \ --header 'Authorization: Basic ' **Sample Response** Success .. sourcecode:: json { "Authorised" } .. sourcecode:: json { "Admin user" } Error .. sourcecode:: json { "error": { "status": 400, "message": "app not given" } } .. sourcecode:: json { "error": { "status": 403, "message": "Not Authorised" } }