{"id":15003643,"url":"https://github.com/checkpointsw/harmony-endpoint-management-js-ts-sdk","last_synced_at":"2026-01-19T21:33:11.158Z","repository":{"id":223515590,"uuid":"758015448","full_name":"CheckPointSW/harmony-endpoint-management-js-ts-sdk","owner":"CheckPointSW","description":"Check Point's Harmony Endpoint management SDK for JavaScript ecosystem","archived":false,"fork":false,"pushed_at":"2024-04-24T17:07:06.000Z","size":198,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"release","last_synced_at":"2024-04-24T19:12:53.616Z","etag":null,"topics":["checkpoint","endpoint","harmony","javascript","sdk","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@chkp/harmony-endpoint-management-sdk","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CheckPointSW.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-15T13:07:52.000Z","updated_at":"2024-06-09T10:50:52.130Z","dependencies_parsed_at":"2024-04-24T18:03:21.189Z","dependency_job_id":"6e008918-b53c-46f5-96de-2f11c7b8d573","html_url":"https://github.com/CheckPointSW/harmony-endpoint-management-js-ts-sdk","commit_stats":null,"previous_names":["checkpointsw/harmony-endpoint-management-js-ts-sdk"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckPointSW%2Fharmony-endpoint-management-js-ts-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckPointSW%2Fharmony-endpoint-management-js-ts-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckPointSW%2Fharmony-endpoint-management-js-ts-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckPointSW%2Fharmony-endpoint-management-js-ts-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CheckPointSW","download_url":"https://codeload.github.com/CheckPointSW/harmony-endpoint-management-js-ts-sdk/tar.gz/refs/heads/release","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247273994,"owners_count":20912029,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["checkpoint","endpoint","harmony","javascript","sdk","typescript"],"created_at":"2024-09-24T18:59:41.286Z","updated_at":"2026-01-19T21:33:11.123Z","avatar_url":"https://github.com/CheckPointSW.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Check Point - Harmony Endpoint Management JS-TS SDK\n\n[![License](https://img.shields.io/github/license/CheckPointSW/harmony-endpoint-management-js-ts-sdk.svg?style=plastic)](https://github.com/CheckPointSW/harmony-endpoint-management-js-ts-sdk/blob/release/LICENSE) [![Latest Release](https://img.shields.io/github/v/release/CheckPointSW/harmony-endpoint-management-js-ts-sdk?style=plastic)](https://github.com/CheckPointSW/harmony-endpoint-management-js-ts-sdk/releases) [![npm version](https://img.shields.io/npm/v/@chkp/harmony-endpoint-management-sdk.svg?style=plastic)](https://www.npmjs.com/package/@chkp/harmony-endpoint-management-sdk)\n\n\u003c!-- \nComing soon :)\n\n[![npm downloads](https://img.shields.io/npm/dt/@chkp/harmony-endpoint-management-sdk.svg.svg?style=plastic)](https://npmjs.com/package/@chkp/harmony-endpoint-management-sdk.svg)\n\n[![GitHub stars](https://img.shields.io/github/stars/CheckPointSW/harmony-endpoint-management-js-ts-sdk.svg?style=social\u0026label=Star)](https://github.com/CheckPointSW/harmony-endpoint-management-js-ts-sdk/stargazers) --\u003e\n\n[![Build SDK Package](https://github.com/CheckPointSW/harmony-endpoint-management-js-ts-sdk/actions/workflows/build.yml/badge.svg)](https://github.com/CheckPointSW/harmony-endpoint-management-js-ts-sdk/actions/workflows/build.yml) [![Publish Package to npmjs](https://github.com/CheckPointSW/harmony-endpoint-management-js-ts-sdk/actions/workflows/release.yml/badge.svg)](https://github.com/CheckPointSW/harmony-endpoint-management-js-ts-sdk/actions/workflows/release.yml)\n\n\nThis is the Harmony Endpoint management SDK for JavaScript ecosystem.\n\nThe SDK is based on the public [Harmony Endpoint management OpenAPI](https://app.swaggerhub.com/apis/Check-Point/web-mgmt-external-api-production) specifications.\n\nThe SDK fully supports TypeScript interfaces in parameters and responses.\n\nWith the SDK, you do not have to manage log in, send keep alive requests, worry about session expiration or pull long processing jobs.\n\n\u003e 💡 The Harmony Endpoint SDK supports simultaneous instances with different tenants.\n\n## ⬇️ SDK installation\n\nTo start using this SDK, add the SDK package to your project\n\nVia yarn\n```\nyarn add @chkp/harmony-endpoint-management-sdk\n```\nOr using good old npm\n```\nnpm install @chkp/harmony-endpoint-management-sdk\n```\n\n## 🚀 Getting started\n\nFirst, import the `HarmonyEndpoint` object from the package.\n\n```typescript\nimport { HarmonyEndpoint } from \"@chkp/harmony-endpoint-management-sdk\";\n```\n\nThen, create a new instance of `HarmonyEndpoint`, which provides CloudInfra API credentials and a gateway to connect to.\n\nTo 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).\n\nOnce the Client ID, Secret Key, and Authentication URL are obtained, Harmony Endpoint SDK can be used.\n\nAll API operations can be explored with the `HarmonyEndpoint` instance.\n\nAll API's can be also explored in [SwaggerHub](https://app.swaggerhub.com/apis/Check-Point/web-mgmt-external-api-production)\n\nA complete example:\n\n```typescript\nimport { HarmonyEndpoint, HarmonyResponse, EndpointInterfaces } from \"@chkp/harmony-endpoint-management-sdk\";\n\n// Create a new instance of HarmonyEndpoint (we do support multiple instances in parallel)\nconst he: HarmonyEndpoint = new HarmonyEndpoint();\n\n// Connect to management using CloudInfra API credentials\nawait he.connect({ \n        clientId: \"place here the CI client-id\", // The \"Client ID\"\n        accessKey: \"place here the CI access-key\", // The \"Secret Key\"\n        gateway: \"https://cloudinfra-gw-us.portal.checkpoint.com/auth/external\", // The \"Authentication URL\"\n    });\n\n// Query the API operation\nconst rulesMetadataRes: HarmonyResponse\u003cArray\u003cEndpointInterfaces.RuleMetadata\u003e\u003e = await he.PolicyGeneralApi.getAllRulesMetadata(EndpointInterfaces.RunAsJob.Off);\nconsole.log(rulesMetadataRes.payload); // Your rulebase metadata\n\n// 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.\nconst rulesMetadataJobRes: HarmonyResponse\u003cArray\u003cEndpointInterfaces.RuleMetadata\u003e\u003e = await he.PolicyGeneralApi.getAllRulesMetadata(EndpointInterfaces.RunAsJob.On);\nconsole.log(rulesMetadataJobRes.isJob); // true\nconsole.log(rulesMetadataJobRes.payload); // Your rulebase metadata, same as in non-job operation\n\n// After you finish, disconnect to stop all background session management. \nawait he.disconnect(); \n```\n\n\n\n### 🏠 On-premise\n\n🛠️🛠️🛠️ **Under Development** 🛠️🛠️🛠️\n\nHarmony Endpoint On-premise instances are also supported.\n\n\u003e Pay attention! Not all cloud operations are available for on-premise, also need to specify the SDK version to comply with your Gaia / JHF version\n\n\n```typescript\nimport { EndpointPremiseInterfaces, HarmonyEndpointPremise } from \"@chkp/harmony-endpoint-management-sdk\";\n\n// Create a new instance of HarmonyEndpoint (we do support multiple instances in parallel)\nconst hbp = new HarmonyEndpointPremise();\n\n// Connect to management using CheckPoint Management credentials\nawait hbp.connect({\n\t\tusername: 'xxxx',\n\t\tpassword: 'xxxx',\n\t\turl: 'https://x.x.x.x',\n\t\tdisableTLSChainValidation: false, // Set it true only if you fully trust this URL (e.g. case of internal but not verified https certificate)\n\t});\n\n// Query the API operation\nconst rulesMetadataRes: HarmonyResponse\u003cArray\u003cEndpointPremiseInterfaces.RuleMetadata\u003e\u003e = await hbp.PolicyGeneralApi.getAllRulesMetadata(EndpointPremiseInterfaces.RunAsJob.Off);\nconsole.log(rulesMetadataRes.payload); // Your rulebase metadata\n\n```\n\nOn-Premises API can be explored in [SwaggerHub](https://app.swaggerhub.com/apis/Check-Point/web-mgmt-external-api-premise)\n\n### ☁️ Cloud \u0026 MSSP services APIs\n\nHarmony Endpoint also provides APIs for MSSP and Cloud service management (relevant to SaaS customers only) \n\n\nThe usage is similar to the management API\n```typescript\nimport { HarmonyEndpointSaaS, EndpointSaaSInterfaces } from \"@chkp/harmony-endpoint-management-sdk\";\n\n// Create a new instance of HarmonyEndpointSaaS (we do support multiple instances in parallel)\nconst heSaas: HarmonyEndpointSaaS = new HarmonyEndpointSaaS();\n\n// Connect to service using CloudInfra API credentials\nawait heSaas.connect({\n        clientId: \"place here your CI client-id\", // The \"Client ID\"\n        accessKey: \"place here your CI access-key\", // The \"Secret Key\"\n        gateway: 'https://cloudinfra-gw-us.portal.checkpoint.com/auth/external', // The \"Authentication URL\"\n    }, {\n\t\tactivateMssPSession: false, // Activate MSSP's session management, turn on if you're using MSSP APIs\n\t});\n\n// Query the cloud API operation\nconst instanceStatusRes: HarmonyResponse\u003cEndpointSaaSInterfaces.PublicMachineStatusResponse\u003e = await heSaas.SelfServiceApi.publicMachinesSingleStatus();\nconsole.log(instanceStatusRes.payload); // Your instance status\n\n// After you finish, disconnect to stop all background session management. \nawait heSaas.disconnect(); \n```\n\nAPI available at [SwaggerHub](https://app.swaggerhub.com/apis/Check-Point/harmony-endpoint-cloud-api-prod)\n\n\n##  📦 Versioning\n\nWhile using cloud services, it's recommended to constantly update to the latest published SDK version.\n\nFor on-premises, it's recommended to align the versions of the SDK and the Harmony Endpoint Management service.\n\nYou can view the matching SDK's pulling command from the Harmony Endpoint Web Management Portal - `Settings` \u003e `Developer Tools`.\n\nThe command will be similar to:\n```\nyarn add @chkp/harmony-endpoint-management-sdk@1.0.11-JHF-R81_20_JHF_DEV_T154\n```\n\n## 🔍 Troubleshooting and logging\n\nThe full version and build info of the SDK is available by `HarmonyEndpoint.info()` see example:\n```typescript\nimport { HarmonyEndpoint, HarmonyEndpointSDKInfo } from \"@chkp/harmony-endpoint-management-sdk\";\n\nconst sdkInfo: HarmonyEndpointSDKInfo = HarmonyEndpoint.info();\nconsole.log(sdkInfo): // { sdkBuild: '9728283', spec: 'web-mgmt-external-api-production', specVersion: '1.9.159', releasedOn: '2023-09-10T18:14:38.264Z', sdkVersion: '1.0.2' }\n```\n\n\nHarmony Endpoint Management SDK uses [debug](https://www.npmjs.com/package/debug) package for logging, which makes it very easy to enable and disable logs\n\nThere are 3 loggers, for general info, errors and to inspect the network.\n\nTo enable all, set (or append) to the `DEBUG` environment variable the following string:\n```bash\nDEBUG=\"harmony-endpoint-management:*\"\n```\n\nFor a specific logger as follows:\n```bash\nDEBUG=\"harmony-endpoint-management:info\"\nDEBUG=\"harmony-endpoint-management:error\"\nDEBUG=\"harmony-endpoint-management:network\"\n```\n\n## 🐞 Report Bug\n\nIn case of an issue or a bug found in the SDK, please open an [issue](https://github.com/CheckPointSW/harmony-endpoint-management-js-ts-sdk/issues) or report to us [Check Point Software Technologies Ltd](mailto:harmony-endpoint-external-api@checkpoint.com).\n\n## 🤝 Contributors \n- Haim Kastner - [chkp-haimk](https://github.com/chkp-haimk)\n- Yuval Pomerchik - [chkp-yuvalpo](https://github.com/chkp-yuvalpo)\n- Oren Efraim - [chkp-orenef](https://github.com/chkp-orenef)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckpointsw%2Fharmony-endpoint-management-js-ts-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcheckpointsw%2Fharmony-endpoint-management-js-ts-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckpointsw%2Fharmony-endpoint-management-js-ts-sdk/lists"}