--- title: Check Point R80 slug: connectors/check-point-r80 docTags: createdAt: 2026-06-09T16:29:46.196Z --- The Check Point R80 connector enables automated interactions with Check Point's security management system, facilitating streamlined security operations and policy management. Check Point R80 is a comprehensive security management solution that provides advanced threat prevention and security management capabilities. This connector enables Swimlane Turbine users to automate the creation, deletion, retrieval, and updating of security layers, access rules, application sites, domains, groups, hosts, and networks within the Check Point R80 environment. By integrating with Check Point R80, security teams can streamline their security operations, enforce consistent policies, and respond to threats with agility and precision. ## Prerequisites To effectively utilize the Check Point R80 connector with Swimlane Turbine, ensure the following prerequisites are met: - API Key Authentication: - URL: The base URL of the Check Point R80 management server. - API Key: A valid API key for authenticating requests to the Check Point R80 API. - HTTP Basic Authentication: - URL: The base URL of the Check Point R80 management server. - Username: The username for logging into the Check Point R80 management server. - Password: The password associated with the provided username. ## Capabilities The Check Point R80 connector has the following capabilities: - Access Layer - Create - Access Layer - Delete - Access Layer - Get - Access Layer - Get All - Access Layer - Update - Access Rule - Create - Access Rule - Delete - Access Rule - Update - Application Site - Create - Application Site - Delete - Application Site - Get - Application Site - Get All - Application Site - Update - Application Site Category - Create - Application Site Category - Delete *... and so on* ### Additional Information about Capabilities - "Host - Create" and "Network - Create" tasks can be used to add a Host/Network to a Group on creation. - "Group - Update" can be used to add a pre-existing Host/Network to a Group. - To block objects, for example IPs or domains, an access rule must be created and assigned to a group where the objects to be blocked are located. - In the case of applying or using "Show Logs" task, we have added the following two tasks in place: 1. "Show Logs using New Query" task - takes `new-query` as input in the request body. 2. "Show Logs using Query ID" task - takes `query-id` as input in the request body. ## Notes - [Check Point R80 API Documentation](https://sc1.checkpoint.com/documents/latest/APIs/index.html#introduction~v1.6) - [Show Logs Documentation](https://sc1.checkpoint.com/documents/latest/APIs/index.html#web/show-logs~v1.9%20) This connector was last tested against product version: 1.6 # Configurations ## Check Point R80 API Key Authentication Authenticates using an API Key. ### Configuration Parameters | **Parameter** | **Description** | **Type** | **Required** | | ------------- | ---------------------------------- | -------- | ------------ | | url | A URL to the target host. | string | Required | | apikey | API key | string | Required | | verify\_ssl | Verify SSL certificate | boolean | Optional | | http\_proxy | A proxy to route requests through. | string | Optional | ## HTTP Basic Authentication Authenticates using username and password. ### Configuration Parameters | **Parameter** | **Description** | **Type** | **Required** | | ------------- | ---------------------------------- | -------- | ------------ | | url | A URL to the target host. | string | Required | | username | Username | string | Required | | password | Password | string | Required | | verify\_ssl | Verify SSL certificate | boolean | Optional | | http\_proxy | A proxy to route requests through. | string | Optional | # Actions ## Access Layer - Create Creates a new access layer in Check Point R80 with a specified name provided in the JSON body input. ### Endpoint - **URL:** `/web_api/add-access-layer` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `name` | string | Optional | Object name. Must be unique in the domain | | `add-default-rule` | boolean | Optional | Indicates whether to include a cleanup rule in the new layer | | `applications-and-url-filtering` | boolean | Optional | Whether to enable Applications & URL Filtering blade on the layer | | `content-awareness` | boolean | Optional | Whether to enable Content Awareness blade on the layer | | `detect-using-x-forward-for` | boolean | Optional | Whether to use X-Forward-For HTTP header, which is added by the proxy server to keep track of the original source IP | | `firewall` | boolean | Optional | Whether to enable Firewall blade on the layer | | `implicit-cleanup-action` | string | Optional | The default "catch-all" action for traffic that does not match any explicit or implied rules in the layer. Valid values are "drop" or "accept" | | `mobile-access` | boolean | Optional | Whether to enable Mobile Access blade on the layer | | `shared` | boolean | Optional | Whether this layer is shared | | `tags` | array | Optional | Collection of tag identifiers | | `color` | string | Optional | Color of the object. Should be one of aquamarine, black, blue, crete blue, burlywood, cyan, dark green, khaki, orchid, dark orange, dark sea green, pink, turquoise, dark blue, firebrick, brown, forest green, gold, dark gold, gray, dark gray, light green, lemon chiffon, coral, sea green, sky blue, magenta, purple, slate blue, violet red, navy blue, olive, orange, red, sienna, yellow | | `comments` | string | Optional | Comments string | | `details-level` | string | Optional | The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object. Valid values are "uid", "standard", "full" | | `ignore-warnings` | boolean | Optional | Apply changes ignoring warnings | | `ignore-errors` | boolean | Optional | Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored | ### Input Example `{"name":"Example Name","add-default-rule":true,"applications-and-url-filtering":true,"content-awareness":true,"detect-using-x-forward-for":true,"firewall":true,"implicit-cleanup-action":"string","mobile-access":true,"shared":true,"tags":["string"],"color":"string","comments":"string","details-level":"string","ignore-warnings":true,"ignore-errors":true}` ### Output | **Parameter** | **Type** | **Description** | | -------------------------------- | -------- | ---------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `shared` | boolean | Output field: shared | | `applications-and-url-filtering` | boolean | URL endpoint for the request | | `content-awareness` | boolean | Response content | | `mobile-access` | boolean | Output field: mobile-access | | `detect-using-x-forward-for` | boolean | Output field: detect-using-x-forward-for | | `firewall` | boolean | Output field: firewall | | `implicit-cleanup-action` | string | Output field: implicit-cleanup-action | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | | `tags.uid` | string | Unique identifier | | `tags.name` | string | Name of the resource | | `tags.type` | string | Type of the resource | | `tags.domain` | object | Output field: tags.domain | | `tags.domain.uid` | string | Unique identifier | ### Output Example `{"status_code":200,"response_headers":{"Date":"Tue, 27 Dec 2022 13:47:48 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"a40b877c-b723-4b0b-ac91-cab00bb40f06","name":"hernan-test-rule-1","type":"access-layer...` ## Access Layer - Delete Removes a specified access layer from Check Point R80 by utilizing the provided 'name' parameter. ### Endpoint - **URL:** `/web_api/delete-access-layer` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | --------------- | | `name` | string | Optional | Object name | ### Input Example `{"name":"Example Name"}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `message` | string | Response message | ### Output Example `{"status_code":200,"response_headers":{"Date":"Tue, 27 Dec 2022 16:12:05 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"message":"OK"}}` ## Access Layer - Get Retrieve details of a specific access layer in Check Point R80 using the unique identifier (UID). ### Endpoint - **URL:** `/web_api/show-access-layer` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ------------------------ | | `uid` | string | Optional | Object Unique Identifier | ### Input Example `{"uid":"string"}` ### Output | **Parameter** | **Type** | **Description** | | -------------------------------- | -------- | ------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `shared` | boolean | Output field: shared | | `applications-and-url-filtering` | boolean | URL endpoint for the request | | `content-awareness` | boolean | Response content | | `mobile-access` | boolean | Output field: mobile-access | | `firewall` | boolean | Output field: firewall | | `implicit-cleanup-action` | string | Output field: implicit-cleanup-action | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | | `tags.file_name` | string | Name of the resource | | `tags.file` | string | Output field: tags.file | | `meta-info` | object | Output field: meta-info | | `meta-info.lock` | string | Output field: meta-info.lock | | `meta-info.validation-state` | string | Unique identifier | | `meta-info.last-modify-time` | object | Time value | ### Output Example `{"status_code":200,"response_headers":{"Date":"Tue, 27 Dec 2022 13:16:19 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"ed5316fb-8b21-4dc8-a30e-ad438434b605","name":"19380cbe20c24459836e29ccfb846582","type"...` ## Access Layer - Get All Retrieve a comprehensive list of all access control boundaries defined in Check Point R80. ### Endpoint - **URL:** `/web_api/show-access-layers` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | --------------------------------------- | | `limit` | number | Optional | The maximal number of returned results | | `offset` | number | Optional | Number of the results to initially skip | ### Input Example `{"limit":123,"offset":123}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------------- | -------- | ---------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `access-layers` | array | Output field: access-layers | | `access-layers.uid` | string | Unique identifier | | `access-layers.name` | string | Name of the resource | | `access-layers.type` | string | Type of the resource | | `access-layers.domain` | object | Output field: access-layers.domain | | `access-layers.domain.uid` | string | Unique identifier | | `access-layers.domain.name` | string | Name of the resource | | `access-layers.domain.domain-type` | string | Type of the resource | | `from` | number | Output field: from | | `to` | number | Output field: to | | `total` | number | Output field: total | ### Output Example `{"status_code":200,"response_headers":{"Date":"Tue, 27 Dec 2022 13:01:23 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"access-layers":[{"uid":"1063010e-4878-48d2-ae1e-f2cf056e142c","name":"6c1aa2ecb1424ec19e42f0...` ## Access Layer - Update Updates an existing access layer in Check Point R80 using the specified unique identifier (UID). ### Endpoint - **URL:** `/web_api/set-access-layer` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `uid` | string | Optional | Object's unique identifier | | `applications-and-url-filtering` | boolean | Optional | Whether to enable Applications & URL Filtering blade on the layer | | `content-awareness` | boolean | Optional | Whether to enable Content Awareness blade on the layer | | `detect-using-x-forward-for` | boolean | Optional | Whether to use X-Forward-For HTTP header, which is added by the proxy server to keep track of the original source IP | | `firewall` | boolean | Optional | Whether to enable Firewall blade on the layer | | `implicit-cleanup-action` | string | Optional | The default "catch-all" action for traffic that does not match any explicit or implied rules in the layer. Valid values are "drop" or "accept" | | `mobile-access` | boolean | Optional | Whether to enable Mobile Access blade on the layer | | `shared` | boolean | Optional | Whether this layer is shared | | `tags` | array | Optional | Collection of tag identifiers | | `color` | string | Optional | Color of the object. Should be one of aquamarine, black, blue, crete blue, burlywood, cyan, dark green, khaki, orchid, dark orange, dark sea green, pink, turquoise, dark blue, firebrick, brown, forest green, gold, dark gold, gray, dark gray, light green, lemon chiffon, coral, sea green, sky blue, magenta, purple, slate blue, violet red, navy blue, olive, orange, red, sienna, yellow | | `comments` | string | Optional | Comments string | | `details-level` | string | Optional | The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object. Valid values are "uid", "standard", "full" | | `ignore-warnings` | boolean | Optional | Apply changes ignoring warnings | | `ignore-errors` | boolean | Optional | Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored | ### Input Example `{"uid":"string","applications-and-url-filtering":true,"content-awareness":true,"detect-using-x-forward-for":true,"firewall":true,"implicit-cleanup-action":"string","mobile-access":true,"shared":true,"tags":["string"],"color":"string","comments":"string","details-level":"string","ignore-warnings":true,"ignore-errors":true}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `code` | string | Output field: code | | `message` | string | Response message | ### Output Example `{"status_code":409,"response_headers":{"Date":"Tue, 27 Dec 2022 15:53:31 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"Conflict","json_body":{"code":"generic_err_object_locked","message":"Requested object with ObjId: [a40b877c-b7...` ## Access Rule - Create Creates a new access rule at a specified layer and position in Check Point R80, with 'layer' and 'position' as required inputs. ### Endpoint - **URL:** `/web_api/add-access-rule` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | --------------------------------------------------------------------------------------------- | | `layer` | string | Optional | Layer that the rule belongs to identified by the name or UID | | `position` | string | Optional | Position in the rulebase. Valid values are "top" or "bottom" | | `name` | string | Optional | Rule name | | `action` | string | Optional | One of "Accept", "Drop", "Ask", "Inform", "Reject", "User Auth", "Client Auth", "Apply Layer" | | `content-negate` | boolean | Optional | True if negate is set for data | | `enabled` | boolean | Optional | Enable/Disable the rule | | `source-negate` | boolean | Optional | True if negate is set for source | | `comments` | string | Optional | Comments string | ### Input Example `{"layer":"string","position":"string","name":"Example Name","action":"Drop","content-negate":true,"enabled":true,"source-negate":true,"comments":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------- | -------- | ------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `track` | object | Output field: track | | `track.type` | object | Type of the resource | | `track.type.uid` | string | Unique identifier | | `track.type.name` | string | Name of the resource | | `track.type.type` | string | Type of the resource | | `track.type.domain` | object | Type of the resource | | `track.type.domain.uid` | string | Unique identifier | | `track.type.domain.name` | string | Name of the resource | | `track.type.domain.domain-type` | string | Type of the resource | | `track.per-session` | boolean | Output field: track.per-session | | `track.per-connection` | boolean | Output field: track.per-connection | | `track.accounting` | boolean | Output field: track.accounting | | `track.enable-firewall-session` | boolean | Output field: track.enable-firewall-session | | `track.alert` | string | Output field: track.alert | | `layer` | string | Output field: layer | | `source` | array | Output field: source | ### Output Example `{"status_code":200,"response_headers":{"Date":"Thu, 29 Dec 2022 15:08:41 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"40ea885a-3d4a-4991-93c0-831865bd45e8","name":"Hernan Rule 2","type":"access-rule","dom...` ## Access Rule - Delete Removes a specified access rule from a layer in Check Point R80 using the provided UID and layer details. ### Endpoint - **URL:** `/web_api/delete-access-rule` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ------------------------------------------------------------ | | `uid` | string | Optional | Object's unique identifier | | `layer` | string | Optional | Layer that the rule belongs to identified by the name or UID | ### Input Example `{"uid":"string","layer":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `message` | string | Response message | ### Output Example `{"status_code":200,"response_headers":{"Date":"Thu, 29 Dec 2022 20:45:08 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"message":"OK"}}` ## Access Rule - Update Updates an existing access rule in Check Point R80 using a unique identifier and specified layer, with configuration details provided in JSON format. ### Endpoint - **URL:** `/web_api/set-access-rule` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | --------------------------------------------------------------------------------------------- | | `uid` | string | Optional | Object unique identifier | | `layer` | string | Optional | Layer that the rule belongs to identified by the name or UID | | `new-name` | string | Optional | New name of the object | | `new-position` | string | Optional | New position in the rulebase. Valid values are "top" or "bottom" | | `action` | string | Optional | One of "Accept", "Drop", "Ask", "Inform", "Reject", "User Auth", "Client Auth", "Apply Layer" | | `content-negate` | boolean | Optional | True if negate is set for data | | `enabled` | boolean | Optional | Enable/Disable the rule | | `source-negate` | boolean | Optional | True if negate is set for source | | `comments` | string | Optional | Comments string | ### Input Example `{"uid":"string","layer":"string","new-name":"Example Name","new-position":"string","action":"Drop","content-negate":true,"enabled":true,"source-negate":true,"comments":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------- | -------- | ------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `track` | object | Output field: track | | `track.type` | object | Type of the resource | | `track.type.uid` | string | Unique identifier | | `track.type.name` | string | Name of the resource | | `track.type.type` | string | Type of the resource | | `track.type.domain` | object | Type of the resource | | `track.type.domain.uid` | string | Unique identifier | | `track.type.domain.name` | string | Name of the resource | | `track.type.domain.domain-type` | string | Type of the resource | | `track.per-session` | boolean | Output field: track.per-session | | `track.per-connection` | boolean | Output field: track.per-connection | | `track.accounting` | boolean | Output field: track.accounting | | `track.enable-firewall-session` | boolean | Output field: track.enable-firewall-session | | `track.alert` | string | Output field: track.alert | | `layer` | string | Output field: layer | | `source` | array | Output field: source | ### Output Example `{"status_code":200,"response_headers":{"Date":"Thu, 29 Dec 2022 15:26:32 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"78f98014-b77c-4bb9-8e37-e410f3d3a412","name":"Cleanup rule","type":"access-rule","doma...` ## Application Site Category - Create Creates a new application site category in Check Point R80 using the specified name provided in the JSON body. ### Endpoint - **URL:** `/web_api/add-application-site-category` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Optional | Object name. Must be unique in the domain | | `description` | string | Optional | Description | | `tags` | string | Optional | Collection of tag identifiers | | `color` | string | Optional | Color of the object. Must be one of aquamarine, black, blue, crete blue, burlywood, cyan, dark green, khaki, orchid, dark orange, dark sea green, pink, turquoise, dark blue, firebrick, brown, forest green, gold, dark gold, gray, dark gray, light green, lemon chiffon, coral, sea green, sky blue, magenta, purple, slate blue, violet red, navy blue, olive, orange, red, sienna, yellow | | `comments` | string | Optional | Comments string | ### Input Example `{"name":"Example Name","description":"string","tags":"string","color":"string","comments":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------------- | -------- | ---------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `description` | string | Output field: description | | `user-defined` | boolean | Output field: user-defined | | `groups` | array | Output field: groups | | `groups.file_name` | string | Name of the resource | | `groups.file` | string | Output field: groups.file | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | | `tags.file_name` | string | Name of the resource | | `tags.file` | string | Output field: tags.file | | `meta-info` | object | Output field: meta-info | | `meta-info.lock` | string | Output field: meta-info.lock | | `meta-info.validation-state` | string | Unique identifier | | `meta-info.last-modify-time` | object | Time value | | `meta-info.last-modify-time.posix` | number | Output field: meta-info.last-modify-time.posix | ### Output Example `{"status_code":200,"response_headers":{"Date":"Thu, 29 Dec 2022 21:06:40 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"2d07d799-8007-4ff8-9833-f29b5b664a1d","name":"Hernan app site category 1","type":"appl...` ## Application Site Category - Delete Removes a specified application site category in Check Point R80 using the unique identifier (UID). ### Endpoint - **URL:** `/web_api/delete-application-site-category` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ------------------------ | | `uid` | string | Optional | Unique Object Identifier | ### Input Example `{"uid":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `message` | string | Response message | ### Output Example `{"status_code":200,"response_headers":{"Date":"Thu, 29 Dec 2022 22:26:09 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"message":"OK"}}` ## Application Site Category - Get Retrieve details for a specific application site category in Check Point R80 using the UID provided. ### Endpoint - **URL:** `/web_api/show-application-site-category` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ------------------------ | | `uid` | string | Optional | Object unique identifier | ### Input Example `{"uid":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `description` | string | Output field: description | | `user-defined` | boolean | Output field: user-defined | | `groups` | array | Output field: groups | | `groups.file_name` | string | Name of the resource | | `groups.file` | string | Output field: groups.file | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | | `tags.uid` | string | Unique identifier | | `tags.name` | string | Name of the resource | | `tags.type` | string | Type of the resource | | `tags.domain` | object | Output field: tags.domain | | `tags.domain.uid` | string | Unique identifier | | `tags.domain.name` | string | Name of the resource | | `tags.domain.domain-type` | string | Type of the resource | ### Output Example `{"status_code":200,"response_headers":{"Date":"Thu, 29 Dec 2022 20:59:10 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"6a6536de-422b-40aa-8c52-d10cea3614c2","name":"022b2205d1554d6e9d5b65afd48be623","type"...` ## Application Site Category - Get all Retrieves all application site categories from Check Point R80, requiring a JSON body input for execution. ### Endpoint - **URL:** `/web_api/show-application-site-categories` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | --------------------------------------- | | `limit` | number | Optional | The maximal number of returned results | | `offset` | number | Optional | Number of the results to initially skip | ### Input Example `{"limit":123,"offset":123}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `objects` | array | Output field: objects | | `objects.uid` | string | Unique identifier | | `objects.name` | string | Name of the resource | | `objects.type` | string | Type of the resource | | `objects.domain` | object | Output field: objects.domain | | `objects.domain.uid` | string | Unique identifier | | `objects.domain.name` | string | Name of the resource | | `objects.domain.domain-type` | string | Type of the resource | | `from` | number | Output field: from | | `to` | number | Output field: to | | `total` | number | Output field: total | ### Output Example `{"status_code":200,"response_headers":{"Date":"Thu, 29 Dec 2022 20:54:57 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"objects":[{"uid":"6a6536de-422b-40aa-8c52-d10cea3614c2","name":"022b2205d1554d6e9d5b65afd48b...` ## Application Site Category - Update Updates an existing application site category in Check Point R80 using the specified UID. ### Endpoint - **URL:** `/web_api/set-application-site-category` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `uid` | string | Optional | Object Unique Identifier | | `new-name` | string | Optional | New name of the object | | `description` | string | Optional | Description | | `tags` | string | Optional | Collection of tag identifiers | | `color` | string | Optional | Color of the object. Must be one of aquamarine, black, blue, crete blue, burlywood, cyan, dark green, khaki, orchid, dark orange, dark sea green, pink, turquoise, dark blue, firebrick, brown, forest green, gold, dark gold, gray, dark gray, light green, lemon chiffon, coral, sea green, sky blue, magenta, purple, slate blue, violet red, navy blue, olive, orange, red, sienna, yellow | | `comments` | string | Optional | Comments string | ### Input Example `{"uid":"string","new-name":"Example Name","description":"string","tags":"string","color":"string","comments":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------------- | -------- | ---------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `description` | string | Output field: description | | `user-defined` | boolean | Output field: user-defined | | `groups` | array | Output field: groups | | `groups.file_name` | string | Name of the resource | | `groups.file` | string | Output field: groups.file | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | | `tags.file_name` | string | Name of the resource | | `tags.file` | string | Output field: tags.file | | `meta-info` | object | Output field: meta-info | | `meta-info.lock` | string | Output field: meta-info.lock | | `meta-info.validation-state` | string | Unique identifier | | `meta-info.last-modify-time` | object | Time value | | `meta-info.last-modify-time.posix` | number | Output field: meta-info.last-modify-time.posix | ### Output Example `{"status_code":200,"response_headers":{"Date":"Thu, 29 Dec 2022 22:22:05 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"2d07d799-8007-4ff8-9833-f29b5b664a1d","name":"Hernan app site category 1","type":"appl...` ## Application Site - Create Creates a new application site in Check Point R80 with a specified name, primary category, and list of URLs. ### Endpoint - **URL:** `/web_api/add-application-site` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------------------ | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Optional | Object name. Must be unique in the domain | | `primary-category` | string | Optional | Each application is assigned to one primary category based on its most defining aspect | | `url-list` | array | Optional | URLs that determine this particular application | | `additional-categories` | array | Optional | Used to configure or edit the additional categories of a custom application / site used in the Application and URL Filtering or Threat Prevention | | `description` | string | Optional | A description for the application | | `urls-defined-as-regular-expression` | boolean | Optional | States whether the URL is defined as a Regular Expression or not | | `tags` | array | Optional | Collection of tag identifiers | | `color` | string | Optional | Color of the object. Must be one of aquamarine, black, blue, crete blue, burlywood, cyan, dark green, khaki, orchid, dark orange, dark sea green, pink, turquoise, dark blue, firebrick, brown, forest green, gold, dark gold, gray, dark gray, light green, lemon chiffon, coral, sea green, sky blue, magenta, purple, slate blue, violet red, navy blue, olive, orange, red, sienna, yellow | | `comments` | string | Optional | Comments string | ### Input Example `{"name":"Example Name","primary-category":"string","url-list":["string"],"additional-categories":["string"],"description":"string","urls-defined-as-regular-expression":true,"tags":["string"],"color":"string","comments":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------------ | -------- | ----------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `application-id` | number | Unique identifier | | `primary-category` | string | Output field: primary-category | | `description` | string | Output field: description | | `risk` | string | Output field: risk | | `user-defined` | boolean | Output field: user-defined | | `additional-categories` | array | Output field: additional-categories | | `url-list` | array | URL endpoint for the request | | `urls-defined-as-regular-expression` | boolean | URL endpoint for the request | | `groups` | array | Output field: groups | | `groups.file_name` | string | Name of the resource | | `groups.file` | string | Output field: groups.file | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | | `tags.uid` | string | Unique identifier | ### Output Example `{"status_code":200,"response_headers":{"Date":"Thu, 29 Dec 2022 23:30:01 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"3217f158-a635-4f9f-8c9b-7f460c4baa54","name":"Hernan example application site 1","type...` ## Application Site - Delete Removes a specified application site from Check Point R80 using the provided unique identifier (UID). ### Endpoint - **URL:** `/web_api/delete-application-site` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ------------------------ | | `uid` | string | Optional | Unique Object Identifier | ### Input Example `{"uid":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `message` | string | Response message | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 00:03:05 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"message":"OK"}}` ## Application Site - Get Retrieve detailed information for a specific application site in Check Point R80 by providing the unique identifier (UID). ### Endpoint - **URL:** `/web_api/show-application-site` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ---------------- | | `uid` | string | Optional | Unique Object ID | ### Input Example `{"uid":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ----------------------- | -------- | ----------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `application-id` | number | Unique identifier | | `primary-category` | string | Output field: primary-category | | `description` | string | Output field: description | | `risk` | string | Output field: risk | | `user-defined` | boolean | Output field: user-defined | | `additional-categories` | array | Output field: additional-categories | | `groups` | array | Output field: groups | | `groups.file_name` | string | Name of the resource | | `groups.file` | string | Output field: groups.file | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | | `tags.file_name` | string | Name of the resource | | `tags.file` | string | Output field: tags.file | | `meta-info` | object | Output field: meta-info | ### Output Example `{"status_code":200,"response_headers":{"Date":"Thu, 29 Dec 2022 23:10:12 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"00fa9e3c-36ef-0f65-e053-08241dc22da2","name":"#hashtags","type":"application-site","do...` ## Application Site - Get All Retrieves all application sites from Check Point R80 using specified JSON body input for configuration. ### Endpoint - **URL:** `/web_api/show-application-sites` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | --------------------------------------- | | `limit` | number | Optional | The maximal number of returned results | | `offset` | number | Optional | Number of the results to initially skip | ### Input Example `{"limit":123,"offset":123}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `objects` | array | Output field: objects | | `objects.uid` | string | Unique identifier | | `objects.name` | string | Name of the resource | | `objects.type` | string | Type of the resource | | `objects.domain` | object | Output field: objects.domain | | `objects.domain.uid` | string | Unique identifier | | `objects.domain.name` | string | Name of the resource | | `objects.domain.domain-type` | string | Type of the resource | | `from` | number | Output field: from | | `to` | number | Output field: to | | `total` | number | Output field: total | ### Output Example `{"status_code":200,"response_headers":{"Date":"Thu, 29 Dec 2022 23:06:36 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"objects":[{"uid":"00fa9e3c-36ef-0f65-e053-08241dc22da2","name":"#hashtags","type":"applicati...` ## Application Site - Update Updates an existing application site in Check Point R80 using a unique identifier (UID). ### Endpoint - **URL:** `/web_api/set-application-site` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------------------ | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `uid` | string | Optional | Unique Object ID | | `new-name` | string | Optional | Object name. Must be unique in the domain | | `primary-category` | string | Optional | Each application is assigned to one primary category based on its most defining aspect | | `url-list` | array | Optional | URLs that determine this particular application | | `additional-categories` | array | Optional | Used to configure or edit the additional categories of a custom application / site used in the Application and URL Filtering or Threat Prevention | | `description` | string | Optional | A description for the application | | `urls-defined-as-regular-expression` | boolean | Optional | States whether the URL is defined as a Regular Expression or not | | `tags` | array | Optional | Collection of tag identifiers | | `color` | string | Optional | Color of the object. Must be one of aquamarine, black, blue, crete blue, burlywood, cyan, dark green, khaki, orchid, dark orange, dark sea green, pink, turquoise, dark blue, firebrick, brown, forest green, gold, dark gold, gray, dark gray, light green, lemon chiffon, coral, sea green, sky blue, magenta, purple, slate blue, violet red, navy blue, olive, orange, red, sienna, yellow | | `comments` | string | Optional | Comments string | ### Input Example `{"uid":"string","new-name":"Example Name","primary-category":"string","url-list":["string"],"additional-categories":["string"],"description":"string","urls-defined-as-regular-expression":true,"tags":["string"],"color":"string","comments":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------------ | -------- | ----------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `application-id` | number | Unique identifier | | `primary-category` | string | Output field: primary-category | | `description` | string | Output field: description | | `risk` | string | Output field: risk | | `user-defined` | boolean | Output field: user-defined | | `additional-categories` | array | Output field: additional-categories | | `url-list` | array | URL endpoint for the request | | `urls-defined-as-regular-expression` | boolean | URL endpoint for the request | | `groups` | array | Output field: groups | | `groups.file_name` | string | Name of the resource | | `groups.file` | string | Output field: groups.file | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | | `tags.uid` | string | Unique identifier | ### Output Example `{"status_code":200,"response_headers":{"Date":"Thu, 29 Dec 2022 23:39:59 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"3217f158-a635-4f9f-8c9b-7f460c4baa54","name":"hernan application example 3","type":"ap...` ## Domain - Create Creates a new domain or sub-domain in Check Point R80 with specified 'name' and 'is-sub-domain' attributes. ### Endpoint - **URL:** `/web_api/add-dns-domain` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Optional | DNS domain name. Should always start with a '.' character. Should be unique in the domain | | `is-sub-domain` | boolean | Optional | Whether to match sub-domains in addition to the domain itself | | `tags` | array | Optional | Collection of tag identifiers | | `color` | string | Optional | Color of the object. Must be one of aquamarine, black, blue, crete blue, burlywood, cyan, dark green, khaki, orchid, dark orange, dark sea green, pink, turquoise, dark blue, firebrick, brown, forest green, gold, dark gold, gray, dark gray, light green, lemon chiffon, coral, sea green, sky blue, magenta, purple, slate blue, violet red, navy blue, olive, orange, red, sienna, yellow | | `comments` | string | Optional | Comments string | ### Input Example `{"name":"Example Name","is-sub-domain":true,"tags":["string"],"color":"string","comments":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------------- | -------- | ------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `is-sub-domain` | boolean | Output field: is-sub-domain | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | | `tags.file_name` | string | Name of the resource | | `tags.file` | string | Output field: tags.file | | `meta-info` | object | Output field: meta-info | | `meta-info.lock` | string | Output field: meta-info.lock | | `meta-info.validation-state` | string | Unique identifier | | `meta-info.last-modify-time` | object | Time value | | `meta-info.last-modify-time.posix` | number | Output field: meta-info.last-modify-time.posix | | `meta-info.last-modify-time.iso-8601` | string | Output field: meta-info.last-modify-time.iso-8601 | | `meta-info.last-modifier` | string | Output field: meta-info.last-modifier | | `meta-info.creation-time` | object | Time value | | `meta-info.creation-time.posix` | number | Output field: meta-info.creation-time.posix | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 15:36:39 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"b33aacce-a5be-4521-a467-a40a0bee86f3","name":".www.swimlane.com","type":"dns-domain","...` ## Domain - Delete Removes a specified domain from Check Point R80 using the provided unique identifier (UID). ### Endpoint - **URL:** `/web_api/delete-dns-domain` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ------------------------ | | `uid` | string | Optional | Unique Object Identifier | ### Input Example `{"uid":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `message` | string | Response message | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 15:47:38 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"message":"OK"}}` ## Domain - Get Retrieves details of a specific domain in Check Point R80 using the provided UID. ### Endpoint - **URL:** `/web_api/show-dns-domain` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ------------------------ | | `uid` | string | Optional | Unique Object Identifier | ### Input Example `{"uid":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `is-sub-domain` | boolean | Output field: is-sub-domain | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | | `tags.uid` | string | Unique identifier | | `tags.name` | string | Name of the resource | | `tags.type` | string | Type of the resource | | `tags.domain` | object | Output field: tags.domain | | `tags.domain.uid` | string | Unique identifier | | `tags.domain.name` | string | Name of the resource | | `tags.domain.domain-type` | string | Type of the resource | | `meta-info` | object | Output field: meta-info | | `meta-info.lock` | string | Output field: meta-info.lock | | `meta-info.validation-state` | string | Unique identifier | | `meta-info.last-modify-time` | object | Time value | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 15:07:33 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"540cbca6-4310-4d20-8b71-9dc24dc669a6","name":".269a0d7638494a48ba4f14a467532a41","type...` ## Domain - Get All Retrieves all domains from Check Point R80, requiring a specified JSON body input for execution. ### Endpoint - **URL:** `/web_api/show-dns-domains` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | --------------------------------------- | | `limit` | number | Optional | The maximal number of returned results | | `offset` | number | Optional | Number of the results to initially skip | ### Input Example `{"limit":123,"offset":123}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `objects` | array | Output field: objects | | `objects.uid` | string | Unique identifier | | `objects.name` | string | Name of the resource | | `objects.type` | string | Type of the resource | | `objects.domain` | object | Output field: objects.domain | | `objects.domain.uid` | string | Unique identifier | | `objects.domain.name` | string | Name of the resource | | `objects.domain.domain-type` | string | Type of the resource | | `from` | number | Output field: from | | `to` | number | Output field: to | | `total` | number | Output field: total | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 15:03:43 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"objects":[{"uid":"540cbca6-4310-4d20-8b71-9dc24dc669a6","name":".269a0d7638494a48ba4f14a4675...` ## Domain - Update Updates a specified domain in Check Point R80 using the provided UID. Include UID in the JSON body for successful operation. ### Endpoint - **URL:** `/web_api/set-dns-domain` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `uid` | string | Optional | Unique Object Identifier | | `new-name` | string | Optional | DNS domain name. Should always start with a '.' character. Should be unique in the domain | | `is-sub-domain` | boolean | Optional | Whether to match sub-domains in addition to the domain itself | | `tags` | array | Optional | Collection of tag identifiers | | `color` | string | Optional | Color of the object. Must be one of aquamarine, black, blue, crete blue, burlywood, cyan, dark green, khaki, orchid, dark orange, dark sea green, pink, turquoise, dark blue, firebrick, brown, forest green, gold, dark gold, gray, dark gray, light green, lemon chiffon, coral, sea green, sky blue, magenta, purple, slate blue, violet red, navy blue, olive, orange, red, sienna, yellow | | `comments` | string | Optional | Comments string | ### Input Example `{"uid":"string","new-name":"Example Name","is-sub-domain":true,"tags":["string"],"color":"string","comments":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `is-sub-domain` | boolean | Output field: is-sub-domain | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | | `tags.uid` | string | Unique identifier | | `tags.name` | string | Name of the resource | | `tags.type` | string | Type of the resource | | `tags.domain` | object | Output field: tags.domain | | `tags.domain.uid` | string | Unique identifier | | `tags.domain.name` | string | Name of the resource | | `tags.domain.domain-type` | string | Type of the resource | | `meta-info` | object | Output field: meta-info | | `meta-info.lock` | string | Output field: meta-info.lock | | `meta-info.validation-state` | string | Unique identifier | | `meta-info.last-modify-time` | object | Time value | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 15:44:32 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"540cbca6-4310-4d20-8b71-9dc24dc669a6","name":".269a0d7638494a48ba4f14a467532a41","type...` ## Group - Create Creates a new group in Check Point R80 with a specified name provided in the JSON body input. ### Endpoint - **URL:** `/web_api/add-group` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Optional | Object name. Must be unique in the domain | | `members` | array | Optional | Collection of Network objects identified by the name or UID | | `tags` | array | Optional | Collection of tag identifiers | | `color` | string | Optional | Color of the object. Must be one of aquamarine, black, blue, crete blue, burlywood, cyan, dark green, khaki, orchid, dark orange, dark sea green, pink, turquoise, dark blue, firebrick, brown, forest green, gold, dark gold, gray, dark gray, light green, lemon chiffon, coral, sea green, sky blue, magenta, purple, slate blue, violet red, navy blue, olive, orange, red, sienna, yellow | | `comments` | string | Optional | Comments string | ### Input Example `{"name":"Example Name","members":["string"],"tags":["string"],"color":"string","comments":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | ---------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `members` | array | Output field: members | | `members.uid` | string | Unique identifier | | `members.name` | string | Name of the resource | | `members.type` | string | Type of the resource | | `members.domain` | object | Output field: members.domain | | `members.domain.uid` | string | Unique identifier | | `members.domain.name` | string | Name of the resource | | `members.domain.domain-type` | string | Type of the resource | | `members.ipv4-address` | string | Output field: members.ipv4-address | | `groups` | array | Output field: groups | | `groups.file_name` | string | Name of the resource | | `groups.file` | string | Output field: groups.file | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 16:58:04 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"0897ebc6-7f8b-4019-96b9-0efef1cc1d0a","name":"Swimlane group 1","type":"group","domain...` ## Group - Delete Removes a specified group from Check Point R80 using the provided unique identifier (UID). ### Endpoint - **URL:** `/web_api/delete-group` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ------------------------ | | `uid` | string | Optional | Unique Object Identifier | ### Input Example `{"uid":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `message` | string | Response message | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 17:15:14 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"message":"OK"}}` ## Group - Get Retrieves details for a specified group in Check Point R80 using the provided unique identifier (UID). ### Endpoint - **URL:** `/web_api/show-group` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | --------------------------------------------------------------------------------------------------------- | | `uid` | string | Optional | Unique Object Identifier | | `show-as-ranges` | boolean | Optional | When true, the group's matched content is displayed as ranges of IP addresses rather than network objects | ### Input Example `{"uid":"string","show-as-ranges":true}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | ---------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `members` | array | Output field: members | | `members.uid` | string | Unique identifier | | `members.name` | string | Name of the resource | | `members.type` | string | Type of the resource | | `members.domain` | object | Output field: members.domain | | `members.domain.uid` | string | Unique identifier | | `members.domain.name` | string | Name of the resource | | `members.domain.domain-type` | string | Type of the resource | | `members.subnet4` | string | Output field: members.subnet4 | | `members.mask-length4` | number | Output field: members.mask-length4 | | `members.subnet-mask` | string | Output field: members.subnet-mask | | `groups` | array | Output field: groups | | `groups.file_name` | string | Name of the resource | | `groups.file` | string | Output field: groups.file | | `comments` | string | Output field: comments | | `color` | string | Output field: color | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 16:33:40 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"b92f7002-60dc-49bf-9b96-3e3367068687","name":"01138b85ae344cd5b6a07c82971bd7e6","type"...` ## Group - Get All Retrieves a comprehensive list of all configured groups within Check Point R80, with an option to specify criteria in a JSON body. ### Endpoint - **URL:** `/web_api/show-groups` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | --------------------------------------- | | `limit` | number | Optional | The maximal number of returned results | | `offset` | number | Optional | Number of the results to initially skip | ### Input Example `{"limit":123,"offset":123}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `objects` | array | Output field: objects | | `objects.uid` | string | Unique identifier | | `objects.name` | string | Name of the resource | | `objects.type` | string | Type of the resource | | `objects.domain` | object | Output field: objects.domain | | `objects.domain.uid` | string | Unique identifier | | `objects.domain.name` | string | Name of the resource | | `objects.domain.domain-type` | string | Type of the resource | | `from` | number | Output field: from | | `to` | number | Output field: to | | `total` | number | Output field: total | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 16:25:10 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"objects":[{"uid":"b92f7002-60dc-49bf-9b96-3e3367068687","name":"01138b85ae344cd5b6a07c82971b...` ## Group - Update Updates an existing group in Check Point R80 using the specified unique identifier (UID). ### Endpoint - **URL:** `/web_api/set-group` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `uid` | string | Optional | Unified Object Identifier | | `new-name` | string | Optional | Object name. Must be unique in the domain | | `members` | object | Optional | Collection of Network objects identified by the name or UID | | `members.add` | array | Optional | Parameter for Group - Update | | `members.remove` | array | Optional | Parameter for Group - Update | | `groups` | object | Optional | Collection of group identifiers | | `groups.add` | array | Optional | Parameter for Group - Update | | `groups.remove` | array | Optional | Parameter for Group - Update | | `tags` | array | Optional | Collection of tag identifiers | | `color` | string | Optional | Color of the object. Must be one of aquamarine, black, blue, crete blue, burlywood, cyan, dark green, khaki, orchid, dark orange, dark sea green, pink, turquoise, dark blue, firebrick, brown, forest green, gold, dark gold, gray, dark gray, light green, lemon chiffon, coral, sea green, sky blue, magenta, purple, slate blue, violet red, navy blue, olive, orange, red, sienna, yellow | | `comments` | string | Optional | Comments string | ### Input Example `{"uid":"string","new-name":"Example Name","members":{"add":["string"],"remove":["string"]},"groups":{"add":["string"],"remove":["string"]},"tags":["string"],"color":"string","comments":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | ---------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `members` | array | Output field: members | | `members.uid` | string | Unique identifier | | `members.name` | string | Name of the resource | | `members.type` | string | Type of the resource | | `members.domain` | object | Output field: members.domain | | `members.domain.uid` | string | Unique identifier | | `members.domain.name` | string | Name of the resource | | `members.domain.domain-type` | string | Type of the resource | | `members.ipv4-address` | string | Output field: members.ipv4-address | | `groups` | array | Output field: groups | | `groups.file_name` | string | Name of the resource | | `groups.file` | string | Output field: groups.file | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 17:11:56 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"0897ebc6-7f8b-4019-96b9-0efef1cc1d0a","name":"Swimlane group 1","type":"group","domain...` ## Host - Create Creates a new host object in Check Point R80 with a specified name and IP address. ### Endpoint - **URL:** `/web_api/add-host` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Optional | Object name. Must be unique in the domain | | `ip-address` | string | Optional | IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly | | `color` | string | Optional | Color of the object. Must be one of aquamarine, black, blue, crete blue, burlywood, cyan, dark green, khaki, orchid, dark orange, dark sea green, pink, turquoise, dark blue, firebrick, brown, forest green, gold, dark gold, gray, dark gray, light green, lemon chiffon, coral, sea green, sky blue, magenta, purple, slate blue, violet red, navy blue, olive, orange, red, sienna, yellow | | `tags` | array | Optional | Collection of tag identifiers | | `comments` | string | Optional | Comment string | | `groups` | array | Optional | Collection of group identifiers | ### Input Example `{"name":"Example Name","ip-address":"string","color":"string","tags":["string"],"comments":"string","groups":["string"]}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------ | -------- | ------------------------------------ | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `ipv4-address` | string | Output field: ipv4-address | | `interfaces` | array | Output field: interfaces | | `interfaces.file_name` | string | Name of the resource | | `interfaces.file` | string | Output field: interfaces.file | | `nat-settings` | object | Output field: nat-settings | | `nat-settings.auto-rule` | boolean | Output field: nat-settings.auto-rule | | `groups` | array | Output field: groups | | `groups.file_name` | string | Name of the resource | | `groups.file` | string | Output field: groups.file | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | | `tags.file_name` | string | Name of the resource | | `tags.file` | string | Output field: tags.file | | `meta-info` | object | Output field: meta-info | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 18:29:09 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"def1f565-7732-49e4-a766-c25e91629a26","name":"Swimlane host 1","type":"host","domain":...` ## Host - Delete Removes an existing host object from Check Point R80 using its name or UID. ### Endpoint - **URL:** `/web_api/delete-host` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `uid` | string | Optional | Object unique identifier. | | `name` | string | Optional | Object name. | | `details-level` | string | Optional | The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object. | | `ignore-warnings` | boolean | Optional | Apply changes ignoring warnings. Default value is false. | | `ignore-errors` | boolean | Optional | Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored. Default value is false. | ### Input Example `{"json_body":{"uid":"def1f565-7732-49e4-a766-c25e91629a26","name":"New Host 1","details-level":"standard","ignore-warnings":false,"ignore-errors":false}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `message` | string | Response message | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 18:36:24 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"message":"OK"}}` ## Host - Get Retrieves details of a specific host from Check Point R80 using the provided unique identifier (UID). ### Endpoint - **URL:** `/web_api/show-host` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ------------------------ | | `uid` | string | Optional | Unique Object Identifier | ### Input Example `{"uid":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------ | -------- | ------------------------------------ | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `ipv4-address` | string | Output field: ipv4-address | | `interfaces` | array | Output field: interfaces | | `interfaces.file_name` | string | Name of the resource | | `interfaces.file` | string | Output field: interfaces.file | | `nat-settings` | object | Output field: nat-settings | | `nat-settings.auto-rule` | boolean | Output field: nat-settings.auto-rule | | `groups` | array | Output field: groups | | `groups.file_name` | string | Name of the resource | | `groups.file` | string | Output field: groups.file | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | | `tags.file_name` | string | Name of the resource | | `tags.file` | string | Output field: tags.file | | `meta-info` | object | Output field: meta-info | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 18:04:30 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"5ccebaae-2138-41ff-bddf-442ce62f2442","name":"1.1.1.1","type":"host","domain":{"uid":"...` ## Host - Get All Retrieves a comprehensive list of all hosts from Check Point R80, requiring a JSON body with query details. ### Endpoint - **URL:** `/web_api/show-hosts` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | --------------------------------------- | | `limit` | number | Optional | The maximal number of returned results | | `offset` | number | Optional | Number of the results to initially skip | ### Input Example `{"limit":123,"offset":123}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | ---------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `objects` | array | Output field: objects | | `objects.uid` | string | Unique identifier | | `objects.name` | string | Name of the resource | | `objects.type` | string | Type of the resource | | `objects.domain` | object | Output field: objects.domain | | `objects.domain.uid` | string | Unique identifier | | `objects.domain.name` | string | Name of the resource | | `objects.domain.domain-type` | string | Type of the resource | | `objects.ipv4-address` | string | Output field: objects.ipv4-address | | `from` | number | Output field: from | | `to` | number | Output field: to | | `total` | number | Output field: total | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 17:59:00 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"objects":[{"uid":"5ccebaae-2138-41ff-bddf-442ce62f2442","name":"1.1.1.1","type":"host","doma...` ## Host - Update Updates an existing host in Check Point R80 using a unique identifier (UID) provided in the JSON body. ### Endpoint - **URL:** `/web_api/set-host` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `uid` | string | Optional | Unique Object Identifier | | `new-name` | string | Optional | Object name. Must be unique in the domain | | `ip-address` | string | Optional | IPv4 or IPv6 address. If both addresses are required use ipv4-address and ipv6-address fields explicitly | | `color` | string | Optional | Color of the object. Must be one of aquamarine, black, blue, crete blue, burlywood, cyan, dark green, khaki, orchid, dark orange, dark sea green, pink, turquoise, dark blue, firebrick, brown, forest green, gold, dark gold, gray, dark gray, light green, lemon chiffon, coral, sea green, sky blue, magenta, purple, slate blue, violet red, navy blue, olive, orange, red, sienna, yellow | | `tags` | array | Optional | Collection of tag identifiers | | `comments` | string | Optional | Comment string | | `groups` | object | Optional | Collection of group identifiers | | `groups.add` | array | Optional | Parameter for Host - Update | | `groups.remove` | array | Optional | Parameter for Host - Update | ### Input Example `{"uid":"string","new-name":"Example Name","ip-address":"string","color":"string","tags":["string"],"comments":"string","groups":{"add":["string"],"remove":["string"]}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------ | -------- | ------------------------------------ | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `ipv4-address` | string | Output field: ipv4-address | | `interfaces` | array | Output field: interfaces | | `interfaces.file_name` | string | Name of the resource | | `interfaces.file` | string | Output field: interfaces.file | | `nat-settings` | object | Output field: nat-settings | | `nat-settings.auto-rule` | boolean | Output field: nat-settings.auto-rule | | `groups` | array | Output field: groups | | `groups.file_name` | string | Name of the resource | | `groups.file` | string | Output field: groups.file | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | | `tags.file_name` | string | Name of the resource | | `tags.file` | string | Output field: tags.file | | `meta-info` | object | Output field: meta-info | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 18:33:42 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"def1f565-7732-49e4-a766-c25e91629a26","name":"Swimlane host 1","type":"host","domain":...` ## Install-Policy Executes the install-policy command on specified targets in Check Point R80, requiring a 'policy-package' name. ### Endpoint - **URL:** `web_api/install-policy` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `policy-package` | string | Optional | The name of the Policy Package to be installed. | | `targets` | array | Optional | On what targets to execute this command. In case 'Specific gateways' is chosen, input installation targets must be in the specific targets list of the policy package. Targets may be identified by their name or object unique identifier. | | `access` | boolean | Optional | Set to be true in order to install the Access Control policy. By default, the value is true if Access Control policy is enabled on the input policy package, otherwise false. | | `desktop-security` | boolean | Optional | Set to be true in order to install the Desktop Security policy. By default, the value is true if Desktop Security policy is enabled on the input policy package, otherwise false. | | `qos` | boolean | Optional | Set to be true in order to install the QoS policy. By default, the value is true if Quality of Service policy is enabled on the input policy package, otherwise false. | | `threat-prevention` | boolean | Optional | Set to be true in order to install the Threat Prevention policy. By default, the value is true if Threat Prevention policy is enabled on the input policy package, otherwise false. | | `install-on-all-cluster-members-or-fail` | boolean | Optional | Relevant for the gateway clusters. If true, the policy is installed on all the cluster members. If the installation on a cluster member fails, don't install on that cluster. | | `prepare-only` | boolean | Optional | If true, prepares the policy for the installation, but doesn't install it on an installation target. | | `revision` | string | Optional | The UID of the revision of the policy to install. | | `ignore-warnings` | boolean | Optional | Install policy ignoring policy mismatch warnings. | ### Input Example `{"json_body":{"policy-package":"Standard","targets":["gateway1"],"access":true,"desktop-security":false,"qos":false,"threat-prevention":true,"install-on-all-cluster-members-or-fail":true,"prepare-only":false,"revision":"test-revision","ignore-warnings":false}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `task-id` | string | Unique identifier | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"task-id":"01234567-89ab-cdef-a930-8c37a59972b3"}}` ## Login Log in to the Check Point R80 server using credentials to obtain a session unique identifier for subsequent requests. ### Endpoint - **URL:** `/web_api/login` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------------ | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `user` | string | Optional | Administrator user name. | | `password` | string | Optional | Administrator password. | | `api-key` | string | Optional | Administrator API key. When using api-key, there is no need to send user/password parameters. | | `continue-last-session` | boolean | Optional | When 'continue-last-session' is set to 'True', the new session would continue where the last session was stopped. This option is available when the administrator has only one session that can be continued. If there is more than one session, see 'switch-session' API. | | `domain` | string | Optional | Use domain to login to specific domain. Domain can be identified by name or UID. | | `enter-last-published-session` | boolean | Optional | Login to the last published session. Such login is done with the Read Only permissions. | | `read-only` | boolean | Optional | Login with Read Only permissions. This parameter is not considered in case continue-last-session is true. | | `session-comments` | string | Optional | Session comments. Can be viewed only using the show-session API. | | `session-description` | string | Optional | A description of the session's purpose. | | `session-name` | string | Optional | Session unique name. | | `session-timeout` | number | Optional | Session expiration timeout in seconds. Default 600 seconds. | ### Input Example `{"json_body":{"user":"test","password":"test","api-key":"12345","continue-last-session":false,"domain":"example.com","enter-last-published-session":false,"read-only":false,"session-comments":"test comments","session-description":"test description","session-name":"test session","session-timeout":600}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | ---------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `sid` | string | Unique identifier | | `url` | string | URL endpoint for the request | | `uid` | string | Unique identifier | | `session-timeout` | number | Output field: session-timeout | | `last-login-was-at` | object | Output field: last-login-was-at | | `last-login-was-at.posix` | number | Output field: last-login-was-at.posix | | `last-login-was-at.iso-8601` | string | Output field: last-login-was-at.iso-8601 | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"sid":"97BVpRfN4j81ogN-V2XqGYmw3DDwIhoSn0og8PiKDiM","url":"https://192.0.2.1:443/web_api","uid":"7a13a360-9b24-40d7-acd3-5b50247be33e","session-timeout":600,"last-login-was-at":{"posix":1430032266851,"iso-8601":"2015-04-26T10:11+0300"}}}` ## Logout Terminate the current session in Check Point R80, invalidating the session ID. ### Endpoint - **URL:** `web_api/logout` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------- | -------- | ------------ | -------------------------------------------------------------- | | `headers` | object | Required | HTTP headers for the request | | `headers.X-chkp-sid` | string | Required | Session unique identifier as it returned by the login request. | | `headers.Content-Type` | string | Optional | Send JSON object to use the API Web Services. | ### Input Example `{"json_body":{},"headers":{"X-chkp-sid":"97BVpRfN4j81ogN-V2XqGYmw3DDwIhoSn0og8PiKDiM","Content-Type":"application/json"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `message` | string | Response message | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"message":"OK"}}` ## Network - Create Creates a new network object in Check Point R80 with specified name, subnet, and subnet mask. ### Endpoint - **URL:** `/web_api/add-network` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Optional | Object name. Must be unique in the domain | | `subnet-mask` | string | Optional | IPv4 network mask | | `subnet` | string | Optional | IPv4 or IPv6 network address. If both addresses are required use subnet4 and subnet6 fields explicitly | | `tags` | array | Optional | Collection of tag identifiers | | `color` | string | Optional | Color of the object. Must be one of aquamarine, black, blue, crete blue, burlywood, cyan, dark green, khaki, orchid, dark orange, dark sea green, pink, turquoise, dark blue, firebrick, brown, forest green, gold, dark gold, gray, dark gray, light green, lemon chiffon, coral, sea green, sky blue, magenta, purple, slate blue, violet red, navy blue, olive, orange, red, sienna, yellow | | `comments` | string | Optional | Comment string | | `groups` | array | Optional | Collection of group identifiers | ### Input Example `{"name":"Example Name","subnet-mask":"string","subnet":"string","tags":["string"],"color":"string","comments":"string","groups":["string"]}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------ | -------- | ------------------------------------ | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `broadcast` | string | Output field: broadcast | | `subnet4` | string | Output field: subnet4 | | `mask-length4` | number | Output field: mask-length4 | | `subnet-mask` | string | Output field: subnet-mask | | `nat-settings` | object | Output field: nat-settings | | `nat-settings.auto-rule` | boolean | Output field: nat-settings.auto-rule | | `groups` | array | Output field: groups | | `groups.file_name` | string | Name of the resource | | `groups.file` | string | Output field: groups.file | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | | `tags.file_name` | string | Name of the resource | | `tags.file` | string | Output field: tags.file | | `meta-info` | object | Output field: meta-info | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 19:29:11 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"a11b304a-5465-44cc-b030-eb8684c74e62","name":"Swimlane Network 1","type":"network","do...` ## Network - Delete Removes a specified network from Check Point R80 using the provided unique identifier (UID). ### Endpoint - **URL:** `/web_api/delete-network` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ------------------------ | | `uid` | string | Optional | Unique Object Identifier | ### Input Example `{"uid":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `message` | string | Response message | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 19:37:06 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"message":"OK"}}` ## Network - Get Retrieves details of a specific network from Check Point R80 using the provided UID. ### Endpoint - **URL:** `/web_api/show-network` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ------------------------ | | `uid` | string | Optional | Unique Object Identifier | ### Input Example `{"uid":"string"}` ### Output | **Parameter** | **Type** | **Description** | | --------------------------- | -------- | ------------------------------------ | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `broadcast` | string | Output field: broadcast | | `subnet4` | string | Output field: subnet4 | | `mask-length4` | number | Output field: mask-length4 | | `subnet-mask` | string | Output field: subnet-mask | | `nat-settings` | object | Output field: nat-settings | | `nat-settings.auto-rule` | boolean | Output field: nat-settings.auto-rule | | `groups` | array | Output field: groups | | `groups.uid` | string | Unique identifier | | `groups.name` | string | Name of the resource | | `groups.type` | string | Type of the resource | | `groups.domain` | object | Output field: groups.domain | | `groups.domain.uid` | string | Unique identifier | | `groups.domain.name` | string | Name of the resource | | `groups.domain.domain-type` | string | Type of the resource | | `comments` | string | Output field: comments | | `color` | string | Output field: color | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 19:19:19 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"4f078348-5f64-45a2-b501-944b78511eba","name":"22def595c2a64f8f976461beff69da69","type"...` ## Network - Get all Retrieves all network objects within the Check Point R80 environment, with optional specifications via JSON body. ### Endpoint - **URL:** `/web_api/show-networks` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | --------------------------------------- | | `limit` | number | Optional | The maximal number of returned results | | `offset` | number | Optional | Number of the results to initially skip | ### Input Example `{"limit":123,"offset":123}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------- | -------- | ---------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `objects` | array | Output field: objects | | `objects.uid` | string | Unique identifier | | `objects.name` | string | Name of the resource | | `objects.type` | string | Type of the resource | | `objects.domain` | object | Output field: objects.domain | | `objects.domain.uid` | string | Unique identifier | | `objects.domain.name` | string | Name of the resource | | `objects.domain.domain-type` | string | Type of the resource | | `objects.subnet4` | string | Output field: objects.subnet4 | | `objects.mask-length4` | number | Output field: objects.mask-length4 | | `objects.subnet-mask` | string | Output field: objects.subnet-mask | | `objects.subnet6` | string | Output field: objects.subnet6 | | `objects.mask-length6` | number | Output field: objects.mask-length6 | | `from` | number | Output field: from | | `to` | number | Output field: to | | `total` | number | Output field: total | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 19:12:55 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"objects":[{"uid":"4f078348-5f64-45a2-b501-944b78511eba","name":"22def595c2a64f8f976461beff69...` ## Network - Update Updates an existing network object in Check Point R80 using the provided unique identifier (UID). ### Endpoint - **URL:** `/web_api/set-network` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `uid` | string | Optional | Unique Object Identifier | | `new-name` | string | Optional | Object name. Must be unique in the domain | | `subnet-mask` | string | Optional | IPv4 network mask | | `subnet` | string | Optional | IPv4 or IPv6 network address. If both addresses are required use subnet4 and subnet6 fields explicitly | | `tags` | array | Optional | Collection of tag identifiers | | `color` | string | Optional | Color of the object. Must be one of aquamarine, black, blue, crete blue, burlywood, cyan, dark green, khaki, orchid, dark orange, dark sea green, pink, turquoise, dark blue, firebrick, brown, forest green, gold, dark gold, gray, dark gray, light green, lemon chiffon, coral, sea green, sky blue, magenta, purple, slate blue, violet red, navy blue, olive, orange, red, sienna, yellow | | `comments` | string | Optional | Comment string | | `groups` | object | Optional | Collection of group identifiers | | `groups.add` | array | Optional | Parameter for Network - Update | | `groups.remove` | array | Optional | Parameter for Network - Update | ### Input Example `{"uid":"string","new-name":"Example Name","subnet-mask":"string","subnet":"string","tags":["string"],"color":"string","comments":"string","groups":{"add":["string"],"remove":["string"]}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------ | -------- | ------------------------------------ | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `type` | string | Type of the resource | | `domain` | object | Output field: domain | | `domain.uid` | string | Unique identifier | | `domain.name` | string | Name of the resource | | `domain.domain-type` | string | Type of the resource | | `broadcast` | string | Output field: broadcast | | `subnet4` | string | Output field: subnet4 | | `mask-length4` | number | Output field: mask-length4 | | `subnet-mask` | string | Output field: subnet-mask | | `nat-settings` | object | Output field: nat-settings | | `nat-settings.auto-rule` | boolean | Output field: nat-settings.auto-rule | | `groups` | array | Output field: groups | | `groups.file_name` | string | Name of the resource | | `groups.file` | string | Output field: groups.file | | `comments` | string | Output field: comments | | `color` | string | Output field: color | | `icon` | string | Output field: icon | | `tags` | array | Output field: tags | | `tags.file_name` | string | Name of the resource | | `tags.file` | string | Output field: tags.file | | `meta-info` | object | Output field: meta-info | ### Output Example `{"status_code":200,"response_headers":{"Date":"Fri, 30 Dec 2022 19:34:01 GMT","Server":"CPWS","Strict-Transport-Security":"max-age=31536000; includeSubDomains","X-Frame-Options":"SAMEORIGIN","Content-Type":"application/json","X-UA-Compatible":"IE=EmulateIE8","X-Forwarded-Host-Port":"443","Keep-Alive":"timeout=15, max=99","Connection":"Keep-Alive","Transfer-Encoding":"chunked"},"reason":"OK","json_body":{"uid":"a11b304a-5465-44cc-b030-eb8684c74e62","name":"Swimlane Network 1","type":"network","do...` ## Publish Applies all configuration changes made by the user across Check Point R80, requiring a 'uid' for identification. ### Endpoint - **URL:** `web_api/publish` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------- | | `uid` | string | Optional | Session unique identifier. Specify it to publish a different session than the one you currently use. | ### Input Example `{"json_body":{"uid":"7a13a360-9b24-40d7-acd3-5b50247be33e"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `task-id` | string | Unique identifier | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"task-id":"01234567-89ab-cdef-a930-8c37a59972b3"}}` ## Show-Access-Rulebase Displays the entire Access Rules layer in Check Point R80, requiring either UID or object name. ### Endpoint - **URL:** `web_api/show-access-rulebase` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ---------------------------------------------------------------------------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | Optional | Object name. Must be unique in the domain. | | `uid` | string | Optional | Object unique identifier. | | `filter` | string | Optional | Search expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression ('AND', 'OR') should be provided in capital letters. If an operator is not used, the default OR operator applies. | | `filter-settings` | object | Optional | Sets filter preferences. | | `filter-settings.search-mode` | string | Optional | When set to 'general', both the Full Text Search and Packet Search are enabled. In this mode, Packet Search will not match on 'Any' object, a negated cell or a group-with-exclusion. When the search-mode is set to 'packet', by default, the match on 'Any' object, a negated cell or a group-with-exclusion are enabled. packet-search-settings may be provided to change the default behavior. | | `filter-settings.packet-search-settings` | object | Optional | When 'search-mode' is set to 'packet', this object allows to set the packet search preferences. | | `filter-settings.packet-search-settings.expand-group-members` | boolean | Optional | When true, if the search expression contains a UID or a name of a group object, results will include rules that match on at least one member of the group. | | `filter-settings.packet-search-settings.expand-group-with-exclusion-members` | boolean | Optional | When true, if the search expression contains a UID or a name of a group-with-exclusion object, results will include rules that match at least one member of the "include" part and is not a member of the "except" part. | | `filter-settings.packet-search-settings.match-on-any` | boolean | Optional | Whether to match on 'Any' object. | | `filter-settings.packet-search-settings.match-on-group-with-exclusion` | boolean | Optional | Whether to match on a group-with-exclusion. | | `filter-settings.packet-search-settings.match-on-negate` | boolean | Optional | Whether to match on a negated cell. | | `limit` | number | Optional | The maximal number of returned results. | | `offset` | number | Optional | Number of the results to initially skip. | | `order` | array | Optional | Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. | | `order.ASC` | string | Optional | Sorts results by the given field in ascending order. | | `order.DESC` | string | Optional | Sorts results by the given field in descending order. | | `package` | string | Optional | Name of the package. | | `show-as-ranges` | boolean | Optional | When true, the source, destination and services & applications parameters are displayed as ranges of IP addresses and port numbers rather than network objects. Objects that are not represented using IP addresses or port numbers are presented as objects. In addition, the response of each rule does not contain the parameters are source, source-negate, destination, destination-negate, service and service-negate, but instead it contains the parameters are source-ranges, destination-ranges and service-ranges. Note - Requesting to show rules as ranges is limited up to 20 rules per request, otherwise an error is returned. If you wish to request more rules, use the offset and limit parameters to limit your request. | | `show-hits` | boolean | Optional | Indicates whether to show hits for the rules. | | `use-object-dictionary` | boolean | Optional | Indicates whether to use the object dictionary. | | `hits-settings` | object | Optional | Specifies the settings for the hits. | | `hits-settings.from-date` | string | Optional | Format is YYYY-MM-DD, "YYYY-mm-ddThh\:mm\:ss". | | `hits-settings.target` | string | Optional | Target gateway name or UID. | | `hits-settings.to-date` | string | Optional | Format is YYYY-MM-DD, "YYYY-mm-ddThh\:mm\:ss". | | `dereference-group-members` | boolean | Optional | Indicates whether to dereference "members" field by details level for every object in reply. | ### Input Example `{"json_body":{"name":"test-rule","uid":"7a13a360-9b24-40d7-acd3-5b50247be33e","filter":"source:192.168.1.1 AND destination:10.0.0.1","filter-settings":{"search-mode":"general","packet-search-settings":{"expand-group-members":false,"expand-group-with-exclusion-members":false,"match-on-any":true,"match-on-group-with-exclusion":true,"match-on-negate":true}},"limit":50,"offset":0,"order":[{"ASC":"name"}],"package":"Standard","show-as-ranges":false,"show-hits":false,"use-object-dictionary":false,"hits-settings":{"from-date":"2024-01-01","target":"gateway1","to-date":"2024-12-31"},"dereference-group-members":false,"show-membership":false,"details-level":"standard"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------------------------- | -------- | ---------------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `uid` | string | Unique identifier | | `name` | string | Name of the resource | | `from` | number | Output field: from | | `to` | number | Output field: to | | `total` | number | Output field: total | | `rulebase` | array | Output field: rulebase | | `rulebase.uid` | string | Unique identifier | | `rulebase.name` | string | Name of the resource | | `rulebase.type` | string | Type of the resource | | `rulebase.domain` | object | Output field: rulebase.domain | | `rulebase.domain.uid` | string | Unique identifier | | `rulebase.domain.name` | string | Name of the resource | | `rulebase.domain.domain-type` | string | Type of the resource | | `rulebase.enabled` | boolean | Output field: rulebase.enabled | | `rulebase.comments` | string | Output field: rulebase.comments | | `rulebase.meta-info` | object | Output field: rulebase.meta-info | | `rulebase.meta-info.lock` | string | Output field: rulebase.meta-info.lock | | `rulebase.meta-info.validation-state` | string | Unique identifier | | `rulebase.meta-info.last-modify-time` | object | Time value | | `rulebase.meta-info.last-modify-time.posix` | number | Output field: rulebase.meta-info.last-modify-time.posix | | `rulebase.meta-info.last-modify-time.iso-8601` | string | Output field: rulebase.meta-info.last-modify-time.iso-8601 | | `rulebase.meta-info.last-modifier` | string | Output field: rulebase.meta-info.last-modifier | | `rulebase.meta-info.creation-time` | object | Time value | ### Output Example `{"uid":"string","name":"Example Name","from":123,"to":123,"total":123,"rulebase":[{"uid":"string","name":"Example Name","type":"string","domain":{},"enabled":true,"comments":"string","meta-info":{},"install-on":[],"source":[],"source-negate":true,"destination":[],"destination-negate":true,"service":[],"service-negate":true,"vpn":[]}],"objects-dictionary":[{"uid":"string","name":"Example Name","type":"string","domain":{}}]}` ## Show Logs using New Query Retrieve filtered logs from Check Point R80 using a specified 'new-query' parameter to tailor search results. ### Endpoint - **URL:** `/web_api/show-logs` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------------------- | -------- | ------------ | ----------------------------------------------------------------------- | | `new-query` | object | Optional | Running a new query. | | `new-query.time-frame` | string | Optional | Specify the time frame to query logs | | `new-query.max-logs-per-request` | string | Optional | Limit the number of logs to be retrieved. | | `new-query.filter` | string | Optional | The filter as entered in SmartConsole/SmartView. | | `new-query.custom-start` | string | Optional | This option is only applicable when using the custom time-frame option. | | `new-query.custom-end` | string | Optional | This option is only applicable when using the custom time-frame option. | | `new-query.top` | object | Required | Top results configuration. | | `new-query.top.field` | string | Required | The field on which the top command is executed. | | `new-query.top.count` | string | Optional | The number of results to retrieve. Valid value is 1 - 50. | | `new-query.type` | string | Optional | Type of logs to return. | | `new-query.log-servers` | array | Optional | List of IP's of logs servers to query. | | `ignore-warnings` | boolean | Optional | Ignore warnings if exist. | ### Input Example `{"json_body":{"new-query":{"time-frame":"today","max-logs-per-request":"100","filter":"blade:\"Threat Emulation\"","custom-start":"2019-09-07T15:50-04:00","custom-end":"2020-09-07T15:50-04:00","top":{"field":"blades","count":"10"},"type":"logs","log-servers":["all"]},"ignore-warnings":false}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------ | -------- | ------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `incidents` | array | Unique identifier | | `incidents.isCHKPObject` | string | Unique identifier | | `incidents.resolved` | string | Unique identifier | | `logs` | array | Output field: logs | | `logs.analyzed_on` | string | Output field: logs.analyzed\_on | | `logs.i_f_dir` | string | Output field: logs.i\_f\_dir | | `logs.proto_attr` | array | Output field: logs.proto\_attr | | `logs.proto_attr.isCHKPObject` | string | Output field: logs.proto\_attr.isCHKPObject | | `logs.proto_attr.resolved` | string | Output field: logs.proto\_attr.resolved | | `logs-count` | number | Count value | | `query-id` | string | Unique identifier | | `tops` | array | Output field: tops | | `tops.Firewall` | string | Output field: tops.Firewall | | `tops.System Monitor` | string | Output field: tops.System Monitor | | `tops-count` | number | Count value | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 13 Dec 2023 20:37:23 GMT"},"reason":"OK","json_body":{"incidents":[{}],"logs":[{}],"logs-count":2,"query-id":"aa_be383957-9167-4ca3-b101-a25bc0fbec1c","tops":[{},{}],"tops-count":935}}` ## Show Logs using Query ID Retrieves logs from Check Point R80 using a specified 'query-id' provided in the JSON body. ### Endpoint - **URL:** `/web_api/show-logs` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | --------------------------------------------------------- | | `query-id` | string | Optional | Get the next page of last run query with specified limit. | | `ignore-warnings` | boolean | Optional | Ignore warnings if exist. | ### Input Example `{"json_body":{"query-id":"aa_be383957-9167-4ca3-b101-a25bc0fbec1c","ignore-warnings":false}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------------ | -------- | ------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `incidents` | array | Unique identifier | | `incidents.isCHKPObject` | string | Unique identifier | | `incidents.resolved` | string | Unique identifier | | `logs` | array | Output field: logs | | `logs.analyzed_on` | string | Output field: logs.analyzed\_on | | `logs.i_f_dir` | string | Output field: logs.i\_f\_dir | | `logs.proto_attr` | array | Output field: logs.proto\_attr | | `logs.proto_attr.isCHKPObject` | string | Output field: logs.proto\_attr.isCHKPObject | | `logs.proto_attr.resolved` | string | Output field: logs.proto\_attr.resolved | | `logs-count` | number | Count value | | `query-id` | string | Unique identifier | | `tops` | array | Output field: tops | | `tops.Firewall` | string | Output field: tops.Firewall | | `tops.System Monitor` | string | Output field: tops.System Monitor | | `tops-count` | number | Count value | ### Output Example `{"status_code":200,"response_headers":{"content-length":"140","content-type":"application/json","Date":"Wed, 13 Dec 2023 20:37:23 GMT"},"reason":"OK","json_body":{"incidents":[{}],"logs":[{}],"logs-count":2,"query-id":"aa_be383957-9167-4ca3-b101-a25bc0fbec1c","tops":[{},{}],"tops-count":935}}` ## Where-Used Identifies where the specified object is utilized within Check Point R80 configurations, requiring either UID or name. ### Endpoint - **URL:** `Searches for usage of the target object in other objects and rules.` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | --------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `uid` | string | Optional | Object unique identifier | | `name` | string | Optional | Object name | | `dereference-group-members` | boolean | Optional | Indicates whether to dereference "members" field by details level for every object in reply. | | `show-membership` | boolean | Optional | Indicates whether to calculate and show "groups" field for every object in reply. | | `async-response` | boolean | Optional | Run command in asynchronous mode and return task UID. Use show-task command to check the progress of the task. | | `details-level` | string | Optional | The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object. | | `domains-to-process` | array | Optional | Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are CURRENT\_DOMAIN, ALL\_DOMAINS\_ON\_THIS\_SERVER. | | `indirect` | boolean | Optional | Search for indirect usage. | | `indirect-max-depth` | number | Optional | Maximum nesting level during indirect usage search. | ### Input Example `{"json_body":{"uid":"7a13a360-9b24-40d7-acd3-5b50247be33e","name":"test-rule","dereference-group-members":false,"show-membership":false,"async-response":false,"details-level":"standard","domains-to-process":["CURRENT_DOMAIN"],"indirect":false,"indirect-max-depth":5}}` ### Output | **Parameter** | **Type** | **Description** | | --------------------------------------------------- | -------- | --------------------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `used-directly` | object | Output field: used-directly | | `used-directly.total` | number | Output field: used-directly.total | | `used-directly.objects` | array | Output field: used-directly.objects | | `used-directly.threat-prevention-rules` | array | Output field: used-directly.threat-prevention-rules | | `used-directly.threat-prevention-rules.file_name` | string | Name of the resource | | `used-directly.threat-prevention-rules.file` | string | Output field: used-directly.threat-prevention-rules.file | | `used-directly.nat-rules` | array | Output field: used-directly.nat-rules | | `used-directly.nat-rules.file_name` | string | Name of the resource | | `used-directly.nat-rules.file` | string | Output field: used-directly.nat-rules.file | | `used-directly.access-control-rules` | array | Output field: used-directly.access-control-rules | | `used-directly.access-control-rules.rule` | string | Output field: used-directly.access-control-rules.rule | | `used-directly.access-control-rules.position` | string | Output field: used-directly.access-control-rules.position | | `used-directly.access-control-rules.owner` | string | Output field: used-directly.access-control-rules.owner | | `used-directly.access-control-rules.policy` | string | Output field: used-directly.access-control-rules.policy | | `used-directly.access-control-rules.layer` | string | Output field: used-directly.access-control-rules.layer | | `used-directly.access-control-rules.layer-position` | number | Output field: used-directly.access-control-rules.layer-position | | `used-directly.access-control-rules.package` | string | Output field: used-directly.access-control-rules.package | | `used-indirectly` | object | Output field: used-indirectly | | `used-indirectly.total` | number | Output field: used-indirectly.total | | `used-indirectly.objects` | array | Output field: used-indirectly.objects | | `used-indirectly.threat-prevention-rules` | array | Output field: used-indirectly.threat-prevention-rules | | `used-indirectly.threat-prevention-rules.file_name` | string | Name of the resource | | `used-indirectly.threat-prevention-rules.file` | string | Output field: used-indirectly.threat-prevention-rules.file | ### Output Example `{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"used-directly":{"total":2,"objects":[],"threat-prevention-rules":[],"nat-rules":[],"access-control-rules":[]},"used-indirectly":{"total":6,"objects":[],"threat-prevention-rules":[],"nat-rules":[],"access-control-rules":[]}}}` # Response Headers | **Header** | **Description** | **Example** | | ------------------------- | -------------------------------------------------------- | ----------------------------------- | | Connection | HTTP response header: Connection | Keep-Alive | | content-length | The length of the response body in bytes | 140 | | Content-Type | The media type of the resource | application/json | | Date | The date and time at which the message was originated | Wed, 13 Dec 2023 20:37:23 GMT | | Keep-Alive | HTTP response header: Keep-Alive | timeout=15, max=99 | | Server | Information about the software used by the origin server | CPWS | | Strict-Transport-Security | HTTP response header: Strict-Transport-Security | max-age=31536000; includeSubDomains | | Transfer-Encoding | HTTP response header: Transfer-Encoding | chunked | | X-Forwarded-Host-Port | HTTP response header: X-Forwarded-Host-Port | 443 | | X-Frame-Options | HTTP response header: X-Frame-Options | SAMEORIGIN | | X-UA-Compatible | HTTP response header: X-UA-Compatible | IE=EmulateIE8 |