{"id":19873060,"url":"https://github.com/checkpointsw/harmony-endpoint-management-cli","last_synced_at":"2026-02-13T13:08:36.190Z","repository":{"id":232367889,"uuid":"784152935","full_name":"CheckPointSW/harmony-endpoint-management-cli","owner":"CheckPointSW","description":"Check Point's Harmony Endpoint Official CLI","archived":false,"fork":false,"pushed_at":"2025-02-27T13:30:35.000Z","size":21,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"release","last_synced_at":"2026-01-05T05:26:56.716Z","etag":null,"topics":["checkpoint","cli","endpoint","harmony","security"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/chkp-harmony-endpoint-management-cli/","language":"Python","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-04-09T09:38:32.000Z","updated_at":"2025-02-27T13:22:09.000Z","dependencies_parsed_at":"2024-04-09T13:18:57.793Z","dependency_job_id":"ef29643a-7e1d-48f2-9cfe-e3f802e77f6d","html_url":"https://github.com/CheckPointSW/harmony-endpoint-management-cli","commit_stats":null,"previous_names":["checkpointsw/harmony-endpoint-management-cli"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/CheckPointSW/harmony-endpoint-management-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckPointSW%2Fharmony-endpoint-management-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckPointSW%2Fharmony-endpoint-management-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckPointSW%2Fharmony-endpoint-management-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckPointSW%2Fharmony-endpoint-management-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CheckPointSW","download_url":"https://codeload.github.com/CheckPointSW/harmony-endpoint-management-cli/tar.gz/refs/heads/release","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CheckPointSW%2Fharmony-endpoint-management-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29407336,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-13T06:24:03.484Z","status":"ssl_error","status_checked_at":"2026-02-13T06:23:12.830Z","response_time":78,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","cli","endpoint","harmony","security"],"created_at":"2024-11-12T16:17:41.634Z","updated_at":"2026-02-13T13:08:36.173Z","avatar_url":"https://github.com/CheckPointSW.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Check Point - Harmony Endpoint Management CLI\n\n[![License](https://img.shields.io/github/license/CheckPointSW/harmony-endpoint-management-cli.svg?style=plastic)](https://github.com/CheckPointSW/harmony-endpoint-management-cli/blob/release/LICENSE) [![Latest Release](https://img.shields.io/github/v/release/CheckPointSW/harmony-endpoint-management-cli?style=plastic)](https://github.com/CheckPointSW/harmony-endpoint-management-cli/releases) [![PyPI version](https://img.shields.io/pypi/v/chkp-harmony-endpoint-management-cli.svg?style=plastic)](https://pypi.org/project/chkp-harmony-endpoint-management-cli/)\n\n\n\u003c!-- \nComing soon :)\n\n[![GitHub stars](https://img.shields.io/github/stars/CheckPointSW/harmony-endpoint-management-cli.svg?style=social\u0026label=Star)](https://github.com/CheckPointSW/harmony-endpoint-management-cli/stargazers) --\u003e\n\n[![Build CLI](https://github.com/CheckPointSW/harmony-endpoint-management-cli/actions/workflows/build.yaml/badge.svg)](https://github.com/CheckPointSW/harmony-endpoint-management-cli/actions/workflows/build.yaml) [![Publish CLI](https://github.com/CheckPointSW/harmony-endpoint-management-cli/actions/workflows/release.yml/badge.svg)](https://github.com/CheckPointSW/harmony-endpoint-management-cli/actions/workflows/release.yml)\n\nThis is the Harmony Endpoint management CLI\n\nThe CLI is based on the public [Harmony Endpoint management OpenAPI](https://app.swaggerhub.com/apis/Check-Point/web-mgmt-external-api-production) specifications.\n\nWith the CLI, you do not have to manage log in, send keep alive requests, worry about session expiration or pull long processing jobs.\n\n## ⬇️ CLI Download\n\nTo start using this CLI, install it via PIP (PyPi registry) as a global python command\n```bash \npip install chkp-harmony-endpoint-management-cli\n```\n\n## 🚀 Getting started\n\nFirst of all, need to create CloudInfra API credentials, to obtain it, 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 CLI can be used.\n\nBefore starting, run the help command to understand how to pass the operation's parameters and payload with all the available options.\n```bash\nchkp_harmony_endpoint_management_cli --help\n```\n\nAll available operations can be shown by the command:\n```bash\nchkp_harmony_endpoint_management_cli --print-operations\n```\n\nThe credentials are recommended to be passed to the CLI by the environment variables `CP_CI_CLIENT_ID` `CP_CI_ACCESS_KEY` `CP_CI_GATEWAY`.\n\nBut CLI also supports passing by params `--client-id` `--access-key` `--gateway` params.\n\nTo call an operation, set `--operation` with value from one of the available operations and pass the herders/query/path/body params if required\n\nFor example, the operation `get_all_rules_metadata` requires header for job, so it will look like that:\n```bash\nchkp_harmony_endpoint_management_cli --operation get_all_rules_metadata --header-params \"{ \\\"x-mgmt-run-as-job\\\": \\\"off\\\"}\"\n```\n\nIn case additional payload can be sent, in this example the rule family by query param: \n```bash\nchkp_harmony_endpoint_management_cli --operation get_all_rules_metadata --query-params \"{\\\"ruleFamily\\\" : \\\"Threat Prevention\\\"}\" --header-params \"{ \\\"x-mgmt-run-as-job\\\": \\\"off\\\"}\"\n```\n\nAll APIs and the optional/required parameters can be explored in [SwaggerHub](https://app.swaggerhub.com/apis/Check-Point/web-mgmt-external-api-production)\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, just need to change default target by `--target saas`\n\nAll available operations can be shown by the command:\n```bash\nchkp_harmony_endpoint_management_cli --print-operations --target saas\n```\n\nFor example, the `public_machines_single_status` operation to get service state:\n```bash\nchkp_harmony_endpoint_management_cli --operation public_machines_single_status --target saas\n```\n\nFull API exploration available at [SwaggerHub](https://app.swaggerhub.com/apis/Check-Point/harmony-endpoint-cloud-api-prod)\n\n## 🔍 Troubleshooting and logging\n\nThe full version and build info of the SDK is available by `--info` see example:\n```bash\nchkp_harmony_endpoint_management_cli --info\n```\nThe output should be similar to:\n```text\nCheck Point - Harmony Endpoint Management CLI\n    CLI - version: \"1.1.0\" build: \"11905935\"\n    Cloud SDK - sdk_build:\"11902935\", sdk_version:\"1.1.28\", spec:\"web-mgmt-external-api-production\", spec_version:\"1.9.211\", released_on:\"2024-03-06T17:43:38.616492\"\n    SaaS SDK - sdk_build:\"11902935\", sdk_version:\"1.1.28\", spec:\"harmony-endpoint-cloud-api-prod\", spec_version:\"1.0.665\", released_on:\"2024-03-06T17:43:38.618196\"\n```\n\nHarmony Endpoint Management CLI allows to print verbose logs.\n\nThere are 3 loggers, for general info, errors and to inspect network.\n\nAs default, they will be disabled, to enable logging, pass `--verbose` param with the following value:\n```bash\nchkp_harmony_endpoint_management_cli --verbos *\n```\n\nAnd for a specific logger set the logger name followed by a command as following:\n```bash\nchkp_harmony_endpoint_management_cli --verbos info\nchkp_harmony_endpoint_management_cli --verbos error\nchkp_harmony_endpoint_management_cli --verbos network\n```\n\n## 🐞 Report Bug\n\nIn case of an issue or a bug found in the CLI, please open an [issue](https://github.com/CheckPointSW/harmony-endpoint-management-cli/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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckpointsw%2Fharmony-endpoint-management-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcheckpointsw%2Fharmony-endpoint-management-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcheckpointsw%2Fharmony-endpoint-management-cli/lists"}