Skip to content

Commit f1f22b9

Browse files
committed
Final README
1 parent 2075985 commit f1f22b9

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
# CheckPoint - Harmony Endpoint Management JS-TS SDK
1+
# Check Point - Harmony Endpoint Management JS-TS SDK
22

3-
---
4-
🚧🚧🚧
3+
This is the Harmony Endpoint management SDK for JavaScript ecosystem.
54

6-
**This package is currently in EA (Early Availability) stage. Use with caution, as it may undergo significant changes and improvements. Feedback and contributions are highly encouraged.**
5+
The SDK is based on the public [Harmony Endpoint management OpenAPI](https://app.swaggerhub.com/apis/Check-Point/web-mgmt-external-api-production) specifications.
76

8-
To report a bug, please go to [Report Bug](#-report-bug)
7+
The SDK fully supports TypeScript interfaces in parameters and responses.
98

10-
For feedback please get in touch with us at [Check Point Software Technologies Ltd.](mailto:[email protected])
9+
With the SDK, you do not have to manage log in, send keep alive requests, worry about session expiration or pull long processing jobs.
1110

12-
🚧🚧🚧
11+
> 💡 The Harmony Endpoint SDK supports simultaneous instances with different tenants.
1312
1413
---
14+
🚧🚧🚧
1515

16-
The official Harmony Endpoint management SDK for JavaScript echo-system.
16+
**Note that the SDK package is in Early Availability (EA). Use with caution, as it may undergo changes and improvements. Feedback and contributions are highly encouraged.**
1717

18-
The SDK is based on the public [Harmony Endpoint management OpenAPI](https://app.swaggerhub.com/apis/Check-Point/web-mgmt-external-api-production) spec.
18+
To report a bug, please go to [Report Bug](#-report-bug)
1919

20-
The SDK is straightforward to use with full TypeScript interface support in parameters and responses.
20+
For feedback, please get in touch with us at [Check Point Software Technologies Ltd.](mailto:[email protected])
2121

22-
Using the SDK, no need to perform logins, send keep-alive requests, worry about session expiration or handle long processing jobs pulling, all is managed by the SDK.
22+
🚧🚧🚧
2323

24-
> 💡 The SDK supports parallel instances to different tenants.
24+
---
2525

2626
## ⬇️ SDK installation
2727

@@ -46,9 +46,9 @@ import { HarmonyEndpoint } from "@chkp/harmony-endpoint-management-sdk";
4646

4747
Then, create a new instance of `HarmonyEndpoint`, which provides CloudInfra API credentials and a gateway to connect to.
4848

49-
To obtain CloudInfra credentials, open the Infinity Portal and create a suitable API Key. make sure in the `Service` field to enter `Endpoint`, for more information, refer to [Infinity Portal Administration Guide](https://sc1.checkpoint.com/documents/Infinity_Portal/WebAdminGuides/EN/Infinity-Portal-Admin-Guide/Content/Topics-Infinity-Portal/API-Keys.htm?tocpath=Global%20Settings%7C_____7#API_Keys).
49+
To obtain CloudInfra credentials, open the Infinity Portal and create a suitable API Key. Make sure to select `Endpoint` in the `Service` field. For more information, see [Infinity Portal Administration Guide](https://sc1.checkpoint.com/documents/Infinity_Portal/WebAdminGuides/EN/Infinity-Portal-Admin-Guide/Content/Topics-Infinity-Portal/API-Keys.htm?tocpath=Global%20Settings%7C_____7#API_Keys).
5050

51-
Once the Client ID, Secret Key, and Authentication URL are obtained, Harmony Endpoint SDK can be started to be used.
51+
Once the Client ID, Secret Key, and Authentication URL are obtained, Harmony Endpoint SDK can be used.
5252

5353
All API operations can be explored with the `HarmonyEndpoint` instance.
5454

@@ -76,7 +76,7 @@ console.log(rulesMetadataRes.payload); // Your rulebase metadata
7676
// Also you can query this operation using a job, no extra logic is required, in the background, it will trigger a job and will pull the status till it is finished and return the final results.
7777
const rulesMetadataJobRes: HarmonyResponse<Array<EndpointInterfaces.RuleMetadata>> = await he.PolicyGeneralApi.getAllRulesMetadata(EndpointInterfaces.RunAsJob.On);
7878
console.log(rulesMetadataJobRes.isJob); // true
79-
console.log(rulesMetadataJobRes.payload); // Your rulebase metadata, same as in non-kob operation
79+
console.log(rulesMetadataJobRes.payload); // Your rulebase metadata, same as in non-job operation
8080

8181
// After you finish, disconnect to stop all background session management.
8282
await he.disconnect();
@@ -149,13 +149,13 @@ API available at [SwaggerHub](https://app.swaggerhub.com/apis/Check-Point/harmon
149149

150150
## 📦 Versioning
151151

152-
While using cloud services it's recommended to always update to the latest published SDK version.
152+
While using cloud services, it's recommended to constantly update to the latest published SDK version.
153153

154-
For on-premises, it's recommended to lock the version to the version that matches the running Endpoint service version and update it only after the Endpoint services upgrade.
154+
For on-premises, it's recommended to align the versions of the SDK and the Harmony Endpoint Management service.
155155

156-
The matching SDK's add command can be seen in the web portal at `Harmony Endpoint` -> `Settings` -> `API & SDKs`.
156+
You can view the matching SDK's pulling command from the Harmony Endpoint Web Management Portal - `Settings` > `API & SDKs`.
157157

158-
The adding command will be similar to:
158+
The command will be similar to:
159159
```
160160
yarn add @chkp/[email protected]_20_JHF_DEV_T154
161161
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@chkp/harmony-endpoint-management-sdk",
3-
"version": "1.1.18",
3+
"version": "1.1.27",
44
"description": "The official Harmony Endpoint management SDK for JavaScript echo-system",
55
"main": "dist/index.js",
66
"scripts": {

0 commit comments

Comments
 (0)