### Install LSM Settings Example Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/jmd/install-lsm-settings.j.md Example of how to install LSM settings using the API. ```json { "targets" : [ "lsm_gateway" ] } ``` -------------------------------- ### Example 1: Install LSM Settings - Success Response Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/postman_collections/checkpoint_api-2.1/176_Provisioning/Install_LSM_Settings.md An example of a successful response when installing LSM settings. ```javascript { "tasks": [ { "task-id": "01234567-89ab-cdef-bb46-4530fa75c5bb", "task-name": "Run Command operation", "status": "succeeded", "progress-percentage": 100, "suppressed": false, "task-details": [ { "title": "Run command Install LSM Settings succeeded", "target": "lsm_gateway", "messages": [ "The action has been completed successfully" ] } ] } ] } ``` -------------------------------- ### Install LSM Policy Example Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/jmd/install-lsm-policy.j.md Example of how to install an LSM policy using the API. ```json { "tasks" : [ { "task-id" : "01234567-89ab-cdef-ba25-aabdd03256ec", "task-name" : "Run Command operation", "status" : "succeeded", "progress-percentage" : 100, "suppressed" : false, "task-details" : [ { "title" : "Run command Install LSM Policy succeeded", "target" : "lsm_gateway", "messages" : [ "The action has been completed successfully." ] } ] } ] } ``` -------------------------------- ### Install Database Request Example Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/jmd/install-database.j.md Example of a POST request to the /install-database endpoint to install databases on specified targets. ```http POST {{server}}/install-database Content-Type: application/json X-chkp-sid: {{session}} { "targets" : [ "checkpointhost1", "checkpointhost2" ] } ``` -------------------------------- ### Example 1: Install LSM Policy Response Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/postman_collections/checkpoint_api-2.1/176_Provisioning/Install_LSM_Policy.md Example of a successful response when installing an LSM policy. ```javascript { "tasks": [ { "task-id": "01234567-89ab-cdef-ba25-aabdd03256ec", "task-name": "Run Command operation", "status": "succeeded", "progress-percentage": 100, "suppressed": false, "task-details": [ { "title": "Run command Install LSM Policy succeeded", "target": "lsm_gateway", "messages": [ "The action has been completed successfully." ] } ] } ] } ``` -------------------------------- ### Install LSM Settings Response Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/jmd/install-lsm-settings.j.md Example response after installing LSM settings. ```json { "tasks" : [ { "task-id" : "01234567-89ab-cdef-bb46-4530fa75c5bb", "task-name" : "Run Command operation", "status" : "succeeded", "progress-percentage" : 100, "suppressed" : false, "task-details" : [ { "title" : "Run command Install LSM Settings succeeded", "target" : "lsm_gateway", "messages" : [ "The action has been completed successfully" ] } ] } ] } ``` -------------------------------- ### Install Policy Request Example Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/jmd/install-policy.j.md Example of a POST request to install a policy package. ```http POST {{server}}/install-policy Content-Type: application/json X-chkp-sid: {{session}} { "policy-package" : "standard", "access" : true, "threat-prevention" : true, "targets" : [ "corporate-gateway" ] } ``` -------------------------------- ### Install LSM Settings Request Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/jmd/install-lsm-settings.j.md Example request to install LSM settings. ```http POST {{server}}/install-lsm-settings Content-Type: application/json X-chkp-sid: {{session}} { "targets" : [ "lsm_gateway" ] } ``` -------------------------------- ### Install Database Response Example Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/jmd/install-database.j.md Example of a successful response from the /install-database endpoint, showing task IDs for each target. ```json { "tasks" : [ { "target" : "checkpointhost1", "task-id" : "f4f16175-00ba-4478-9439-a2181d96c446" }, { "target" : "checkpointhost2", "task-id" : "f4f16175-00ba-4478-9439-a2181d96c556" } ] } ``` -------------------------------- ### Install Software Package Request Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/jmd/install-software-package.j.md Example request to install a software package. ```json POST {{server}}/install-software-package Content-Type: application/json X-chkp-sid: {{session}} { "name" : "Check_Point_R80_40_JHF_MCD_DEMO_019_MAIN_Bundle_T1_VISIBLE_FULL.tgz", "package-location" : "automatic", "targets.1" : "corporate-gateway", "cluster-installation-settings.cluster-strategy" : "non-active-members-no-failover" } ``` -------------------------------- ### Request Body Example Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/postman_collections/checkpoint_api-2.1/133_Policy/install-policy.md This is an example of the JSON request body for installing a policy. ```json { "policy-package": "standard", "access": true, "threat-prevention": true, "targets": [ "corporate-gateway" ] } ``` -------------------------------- ### Get Platform Example Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/jmd/get-platform.j.md Example of how to get platform information from a gateway. ```http POST {{server}}/reset-sic Content-Type: application/json X-chkp-sid: {{session}} { "name" : "gw1" } ``` ```json { "tasks" : [ { "task-name" : "get-platform", "task-id" : "01234567-89ab-1234-9e1f-0e1e68312345", "status" : "succeeded", "progress-percentage" : 100, "suppressed" : false, "task-details" : [ { "os-name" : "Gaia", "version" : "R81.10", "hardware" : "Open Server" } ] } ] } ``` -------------------------------- ### Example Response (200 OK) Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/postman_collections/checkpoint_api-2.1/179_Provisioning_Profile/show-provisioning-profile.md This is an example of a successful response when showing a provisioning profile. ```javascript { "uid": "ea51c98a-65aa-3f43-bca8-582c379226c8", "name": "SMBCluster", "type": "provisioning-profile", "domain": { "uid": "41e821a0-3720-11e3-aa6e-0800200c9fde", "name": "SMC User", "domain-type": "domain" }, "dns": { "primary-server": "194.29.40.221", "secondary-server": "194.29.40.220", "tertiary-server": "", "dns-proxy": true, "servers-configuration-mode": "manual", "manage-settings": "locally on the device", "override-settings": "allowed" }, "hosts": { "manage-settings": "centrally from this application", "override-settings": "allowed" }, "domain-name": { "manage-settings": "centrally from this application", "override-settings": "allowed" }, "radius": { "enabled": false, "allow-administrators-from-specific-radius-group-only": false, "manage-settings": "centrally from this application", "override-settings": "allowed" }, "hotspot": { "enabled": false, "display-terms-of-use": false, "require-authentication": false, "allow-users-from-specific-group": false, "manage-settings": "centrally from this application", "override-settings": "allowed" }, "configuration-script": { "manage-settings": "centrally from this application", "override-settings": "allowed" }, "groups": [ { "uid": "a5a615ca-ed33-e045-970e-4511a931a215", "name": "C_SMB_68_34", "type": "", "domain": { "uid": "41e821a0-3720-11e3-aa6e-0800200c9fde", "name": "SMC User", "domain-type": "domain" }, "icon": "Unknown" }, { "uid": "615f88ce-5962-8146-9d60-e2b9647ff974", "name": "C_SMB_68_29", "type": "", "domain": { "uid": "41e821a0-3720-11e3-aa6e-0800200c9fde", "name": "SMC User", "domain-type": "domain" }, "icon": "Unknown" } ], "comments": "", "icon": "NetworkObjects/ROBO/Profile_Provisioning", "tags": [], "meta-info": { "lock": "unlocked", "validation-state": "ok", "last-modify-time": { "posix": 1629971663134, "iso-8601": "2021-08-26T12:54+0300" }, "last-modifier": "aa", "creation-time": { "posix": 1629800112921, "iso-8601": "2021-08-24T13:15+0300" }, "creator": "aa" }, "read-only": false } ``` -------------------------------- ### Example 1: show-best-practices Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/postman_collections/checkpoint_api-2.1/69_Best_Practice/show-best-practices.md This example shows the response body for a successful request to retrieve best practices. It includes details about the best practices found, such as their UID, name, description, and recommended action. ```javascript { "from": 1, "to": 5, "total": 264, "objects": [ { "uid": "097f15a8-6186-4bea-9cfb-877aa9425f47", "name": "Check that 'Clean up Rule' is defined in Access Policy", "type": "compliance-best-practice", "domain": { "uid": "41e821a0-3720-11e3-aa6e-0800200c9fde", "name": "SMC User", "domain-type": "domain" }, "meta-info": { "lock": "unlocked", "validation-state": "ok", "last-modify-time": { "posix": 1747861265056, "iso-8601": "2025-05-22T00:01+0300" }, "last-modifier": "System", "creation-time": { "posix": 1747665908508, "iso-8601": "2025-05-19T17:45+0300" }, "creator": "System" }, "available-actions": { "edit": "true", "delete": "true", "clone": "false" }, "read-only": false, "best-practice-id": "FW101", "description": "This check whether the 'Clean up Rule' is the last row listed in the Access Policy Rule Base and is applied to all Gateways. A 'Clean up Rule' is defined as: Source= Any; Destination= Any; VPN= Any Traffic; Service= Any; Action= Drop; Track= Not None; Install On: all network objects that linked to the Policy, Time= Any,", "action-item": "The 'Clean up Rule' in the Access Policy Rule Base needs to be defined as follows: Source = Any; Destination = Any; VPN = Any Traffic; Service = Any; Action = Drop; Track = Not None; Install On: all network objects that linked to the Policy, Time = Any. Note that the 'Clean up Rule' must be the last row listed in the Access Policy Rule Base. The purpose of the check is to ensure that on each Gateway a clean up rule is enforced. This is enforced by ensuring all policy packages include a clean up rule but at the end of the policy.", "status": "medium", "blade": "firewall", "user-defined": false, "relevant-objects": { "relevant-objects-type": "access-rule", "access-rules-info": [ { "policy-name": "Standard", "layer-name": "Network", "layer-uid": "bc2c2a63-ef09-4e4f-a219-3bda9c621109", "rule-indexes": "", "status": "medium", "enabled": true } ] }, "active": true }, { "uid": "222370d0-4834-4c5b-8389-dc3f5bee90a6", "name": "Check that 'Encrypt DNS traffic' is selected in the Remote Access settings in the Global Properties", "type": "compliance-best-practice", "domain": { "uid": "41e821a0-3720-11e3-aa6e-0800200c9fde", "name": "SMC User", "domain-type": "domain" }, "meta-info": { "lock": "unlocked", "validation-state": "ok", "last-modify-time": { "posix": 1747861265322, "iso-8601": "2025-05-22T00:01+0300" }, "last-modifier": "System", "creation-time": { "posix": 1747665910045, "iso-8601": "2025-05-19T17:45+0300" }, "creator": "System" }, "available-actions": { "edit": "true", "delete": "true", "clone": "true" }, "read-only": false, "best-practice-id": "VPN122", "description": "This checks the Remote Access settings in the Global Properties to ensure that 'Encrypt DNS traffic' is selected", "action-item": "The 'Encrypt DNS traffic' option should be selected in the Remote Access settings in the Global Properties", "status": "secure", "blade": "ipsec-vpn", "user-defined": false, "active": true }, { "uid": "68758daf-04ef-4a7b-84de-a94dc8e3cf4b", "name": "Check the Simultaneous Login setting within Remote Access", "type": "compliance-best-practice", "domain": { "uid": "41e821a0-3720-11e3-aa6e-0800200c9fde", "name": "SMC User", "domain-type": "domain" }, "meta-info": { "lock": "unlocked", "validation-state": "ok", "last-modify-time": { "posix": 1747861267119, "iso-8601": "2025-05-22T00:01+0300" }, "last-modifier": "System", "creation-time": { "posix": 1747665910105, "iso-8601": "2025-05-19T17:45+0300" }, "creator": "System" }, "available-actions": { "edit": "true", "delete": "true", "clone": "true" }, "read-only": false, "best-practice-id": "VPN128", "description": "This checks the Simultaneous Login setting to ensure that 'User is only allowed single login' is selected", "action-item": "In SmartConsole, click Menu - 'Global properties'. Click the 'Remote Access' page. In the 'Simultaneous Login' section, select 'User is only allowed single login'.", "status": "secure", "blade": "ipsec-vpn" } ] } ``` -------------------------------- ### Example Response Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/postman_collections/checkpoint_api-2.1/143_SmartTasks/add-smart-task_that_sends_a_web_request_via_proxy_after_policy_installations.md This is an example of a successful response (200 OK) when adding a smart task that sends a web request via proxy after policy installations. ```javascript { "uid": "19c71ca2-3080-4617-b6ea-7c376e582bb8", "name": "Send Policy Installation Reports", "type": "smart-task", "domain": { "uid": "41e821a0-3720-11e3-aa6e-0800200c9fde", "name": "SMC User", "domain-type": "domain" }, "meta-info": { "lock": "unlocked", "validation-state": "ok", "last-modify-time": { "posix": 1556717294959, "iso-8601": "2019-05-01T16:28+0300" }, "last-modifier": "aa", "creation-time": { "posix": 1556717294959, "iso-8601": "2019-05-01T16:28+0300" }, "creator": "aa" }, "tags": [], "read-only": true, "comments": "", "color": "black", "icon": "Objects/SmartTask", "enabled": true, "trigger": { "uid": "2f98776f-1352-4947-a087-0446d8b5d93c", "name": "After Install Policy", "type": "smart-task-trigger", "domain": { "uid": "a0bbbc99-adef-4ef8-bb6d-defdefdefdef", "name": "Check Point Data", "domain-type": "data domain" } }, "description": "Send policy installation results to the mail address specified in the Custom Data field using the corporate's dedicated web server.", "fail-open": true, "custom-data": "{\"mail-address\": \"example-admin@example-corp.com\"}", "action": { "web-request": { "url": "https://demo.example.com/policy-installation-reports/", "time-out": 30000 } } } ``` -------------------------------- ### Request Body Example Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/postman_collections/checkpoint_api-2.1/64_Network_Interface/get-interfaces_without_topology_by_UID.md Example of a request body to get interfaces without topology. ```json { "target-uid": "2220d9ad-a251-5555-9a0a-4772a6511111", "with-topology": false } ``` -------------------------------- ### Add Application Site Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/jmd/add-application-site.j.md This example demonstrates how to add a new application site with basic details. ```json POST {{server}}/add-application-site Content-Type: application/json X-chkp-sid: {{session}} { "name" : "New Application Site 1", "primary-category" : "Social Networking", "description" : "My Application Site", "additional-categories" : [ "Instant Chat", "Supports Streaming", "New Application Site Category 1" ], "url-list" : [ "www.cnet.com", "www.stackoverflow.com" ], "urls-defined-as-regular-expression" : false } ``` -------------------------------- ### Get Data Center Query Response Example Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/jmd/set-data-center-query.j.md Example response when retrieving data center query details. ```json { "uid" : "8024422d-74c2-487e-a196-a8649e3f88da", "name" : "data-center-query1", "type" : "data-center-query", "domain" : { "uid" : "41e821a0-3720-11e3-aa6e-0800200c9fde", "name" : "SMC User", "domain-type" : "domain" }, "meta-info" : { "lock" : "unlocked", "validation-state" : "ok", "last-modify-time" : { "posix" : 1591519435090, "iso-8601" : "2020-06-07T11:43+0300" }, "last-modifier" : "WEB_API", "creation-time" : { "posix" : 1591513615720, "iso-8601" : "2020-06-07T10:06+0300" }, "creator" : "WEB_API" }, "tags" : [ ], "read-only" : true, "comments" : "", "color" : "black", "icon" : "NetworkObjects/ExternalDataSource", "query-rules" : [ { "uid" : "20387286-f498-4620-a5fb-7de596ba721c", "type" : "DataCenterQueryRule", "domain" : { "uid" : "41e821a0-3720-11e3-aa6e-0800200c9fde", "name" : "SMC User", "domain-type" : "domain" }, "meta-info" : { "lock" : "unlocked", "validation-state" : "ok" }, "tags" : [ ], "read-only" : true, "comments" : "", "color" : "black", "icon" : "NetworkObjects/ExternalDataSource", "key-type" : "PREDEFINED", "key" : "name-in-data-center", "values" : [ "myvalue" ] } ], "data-centers" : [ ], "using-all-data-center" : true } ``` -------------------------------- ### Show Provisioning Profile Response Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/jmd/show-provisioning-profile.j.md This example shows a successful response containing the details of the 'SMBCluster' provisioning profile. ```json { "uid" : "ea51c98a-65aa-3f43-bca8-582c379226c8", "name" : "SMBCluster", "type" : "provisioning-profile", "domain" : { "uid" : "41e821a0-3720-11e3-aa6e-0800200c9fde", "name" : "SMC User", "domain-type" : "domain" }, "dns" : { "primary-server" : "194.29.40.221", "secondary-server" : "194.29.40.220", "tertiary-server" : "", "dns-proxy" : true, "servers-configuration-mode" : "manual", "manage-settings" : "locally on the device", "override-settings" : "allowed" }, "hosts" : { "manage-settings" : "centrally from this application", "override-settings" : "allowed" }, "domain-name" : { "manage-settings" : "centrally from this application", "override-settings" : "allowed" }, "radius" : { "enabled" : false, "allow-administrators-from-specific-radius-group-only" : false, "manage-settings" : "centrally from this application", "override-settings" : "allowed" }, "hotspot" : { "enabled" : false, "display-terms-of-use" : false, "require-authentication" : false, "allow-users-from-specific-group" : false, "manage-settings" : "centrally from this application", "override-settings" : "allowed" }, "configuration-script" : { "manage-settings" : "centrally from this application", "override-settings" : "allowed" }, "groups" : [ { "uid" : "a5a615ca-ed33-e045-970e-4511a931a215", "name" : "C_SMB_68_34", "type" : "", "domain" : { "uid" : "41e821a0-3720-11e3-aa6e-0800200c9fde", "name" : "SMC User", "domain-type" : "domain" }, "icon" : "Unknown" }, { "uid" : "615f88ce-5962-8146-9d60-e2b9647ff974", "name" : "C_SMB_68_29", "type" : "", "domain" : { "uid" : "41e821a0-3720-11e3-aa6e-0800200c9fde", "name" : "SMC User", "domain-type" : "domain" }, "icon" : "Unknown" } ], "comments" : "", "icon" : "NetworkObjects/ROBO/Profile_Provisioning", "tags" : [ ], "meta-info" : { "lock" : "unlocked", "validation-state" : "ok", "last-modify-time" : { "posix" : 1629971663134, "iso-8601" : "2021-08-26T12:54+0300" }, "last-modifier" : "aa", "creation-time" : { "posix" : 1629800112921, "iso-8601" : "2021-08-24T13:15+0300" }, "creator" : "aa" }, "read-only" : false } ``` -------------------------------- ### Show Repository Packages Response Source: https://github.com/chkp-antonr/checkpoint-api-ref/blob/master/jmd/show-repository-packages.j.md Example response showing the details of software packages available in the repository. ```json { "tasks" : [ { "uid" : "f6241fa3-1bca-45a9-a700-968bde6c7219", "type" : "task", "domain" : { "uid" : "41e821a0-3720-11e3-aa6e-0800200c9fde", "name" : "SMC User", "domain-type" : "domain" }, "meta-info" : { "lock" : "unlocked", "validation-state" : "ok", "last-modify-time" : { "posix" : 1588785254969, "iso-8601" : "2020-05-06T20:14+0300" }, "last-modifier" : "WEB_API", "creation-time" : { "posix" : 1588785254029, "iso-8601" : "2020-05-06T20:14+0300" }, "creator" : "WEB_API" }, "tags" : [ ], "read-only" : false, "comments" : "", "color" : "black", "icon" : "General/globalsNa", "task-name" : "Getting information for this software package:all", "task-id" : "bdfd4078-8344-4468-b41e-dd3bc70e6da9", "status" : "succeeded", "progress-percentage" : 100, "start-time" : { "posix" : 1588785254018, "iso-8601" : "2020-05-06T20:14+0300" }, "last-update-time" : { "posix" : 1588785254958, "iso-8601" : "2020-05-06T20:14+0300" }, "suppressed" : true, "task-details" : [ { "uid" : "00189172-c7b3-40c0-ace2-ec14067d63d5", "name" : null, "domain" : { "uid" : "41e821a0-3720-11e3-aa6e-0800200c9fde", "name" : "SMC User", "domain-type" : "domain" }, "color" : "black", "statusDescription" : "", "taskNotification" : "f6241fa3-1bca-45a9-a700-968bde6c7219", "meta-info" : { "validation-state" : "ok", "last-modify-time" : { "posix" : 1588785254882, "iso-8601" : "2020-05-06T20:14+0300" }, "last-modifier" : "WEB_API", "creation-time" : { "posix" : 1588785254882, "iso-8601" : "2020-05-06T20:14+0300" }, "creator" : "WEB_API" }, "tags" : [ ], "icon" : "General/globalsNa", "comments" : "", "display-name" : "", "customFields" : null, "packages" : [ { "category" : "hotfix", "baseVersion" : "R80.20", "name" : "Check_Point_R80_20_JUMBO_HF_Bundle_T118_sk137592_Security_Gateway_and_Standalone_2_6_18_FULL.tgz", "size" : "792422769", "releaseDate" : "2019-10-27 00:00:00", "description" : { "text" : "R80.20 Jumbo Hotfix Accumulator General availability (Take 118). This package is suitable for Security Gateway and Standalone Gaia 2.6.18 machines only. ", "links" : [ ] }, "availability" : "both" }, { "category" : "hotfix", "baseVersion" : "R80.10", "name" : "Check_Point_R80_10_JUMBO_HF_Bundle_T259_FULL.tgz", "size" : "864819325", "releaseDate" : "", "description" : { }, "availability" : "local" } ] } ] } ] } ```