Checkpoint Management Console
App Vendor : Check Point Software Technologies
App Category: Network Security
Connector Version: 1.2.0
API Version: v1.5
About App
The Checkpoint Management Console is an integrated security management solution that includes policy, logging, monitoring, event correlation, and reporting in a single system. Administrators can quickly identify security risks across the organization, configure and view security policies.
The Checkpoint Management Console app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Add Host | This action adds a host to a particular group. |
Show Task | This action retrieves details and the progress of a task. |
List Packages | This action retrieves the list of all packages. |
List Gateways | This action retrieves the list of all gateways and servers. |
List Application Site Category | This action retrieves all the application site categories. |
Add Application Site Catgory | This action adds a new application site category. |
Get application Site category | This action retrieves the existing category object using the name. |
Delete Host | This action deletes a particular host. |
Show Host | This action retrieves details of a particular host. |
Publish all the changes | This action publishes all the changes. |
List Host | This action retrieves the list of all hosts. |
Update Host | This action updates the details of a host. |
Show Group | This action retrieves details of a particular group. |
List Groups | This action retrieves the list of all hosts. |
Delete Group | This action deletes a particular group. |
Add Group | This action adds a particular group. |
List Address Ranges | This action retrieves the list of all address ranges. |
Add Address Range | This action adds an address range. |
Delete Address Range | This action deletes a particular address range. |
Update Address Range | This action edits and updates the address range. |
Show Address Range | This action retrieves details of an address range. |
List Threat Indicators | This action retrieves the list of all threat indicators. |
Show Threat Indicator | This action retrieves the details of the threat indicators. |
Delete Threat Indicator | This action deletes a particular threat indicator. |
Add Threat Indicator | This action adds a threat indicator. |
Update Threat Indicator | This action updates details of a threat indicator. |
List Access Rule | This action retrieves the entire access rules layer. An access rule may be within a section, or independent of a section. |
Update Access Rule | This action updates the details of an access rule. |
Add Access Rule | This action adds an access rule. |
Delete Access Rule | This action deletes an access rule. |
List Application Site | This action retrieves the list of all application sites. |
Add Application Site | This action adds an application site. |
Update Application Site | This action updates details of an application site. |
Install Policy | This action installs a policy. |
Verify Policy | This action verifies the policy of the selected package. |
Update Groups | This action edits and updates a group. |
Delete Application Site | This action deletes the application site. |
Show Object | This action retrieves the data about objects. |
Get List Of Networks | This action retrieves the list of networks. |
Configuration Parameters
The following configuration parameters are required for the Checkpoint Management Console app to communicate with the Checkpoint Management Console enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the base URL to access the Checkpoint Management Console application. Example: "https://<management server>:<port>/web_api/" | Text | Required | |
Port | Enter the port number for your Checkpoint Management console. Example: 443 | Integer | Required | |
User Name | Enter the username for the Checkpoint Management Console application. Example: "exampleUsername" | Text | Required | |
Password | Enter the password for your Checkpoint Management Console. Example: "examplePassword" | Password | Required |
Action: Add Host
This action adds a host to a particular group.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the host to add. Example: "Sample Host" | Text | Required | |
IP Address | Enter the IP address of the host to add. Example: "1.1.1.1" | Text | Required | |
Group List | Enter the group list of the host to add. Example: $LIST[Priority Group, Low Priority Group] | List | Required |
Example Request
[
{
"name":"Sample Host",
"ip_address":"1.1.1.1",
"group_list":[
"Priority Group",
"Low Priority Group"
]
}
]Action: Show Task
This action shows details and the progress of a task.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Task ID | Enter the task ID to see the progress and details of the task. Example: "2eec70e5-78a8-4bdb-9a76-cfb5601d0bcb" | Text | Required |
Example Request
[
{
"task_id": "2eec70e5-78a8-4bdb-9a76-cfb5601d0bcb"
}
]Action: List Packages
This action retrieves the list of all packages.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Limit | Enter the maximum number of groups you want as result. Example: 40 | Integer | Optional | Default value: |
Offset | Enter the number of the results to skip initially on the list. Example: 3 | Integer | Optional | Default value: |
Example Request
[
{
"limit": 40,
"offset": 3
}
]Action: List Gateways
This action retrieves the list of all gateways and servers.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Limit | Enter the maximum number of gateways you want as result. Example: 40 | Integer | Optional | Default value: 50 |
Offset | Enter the number of the results to skip initially on the list. Example: 3 | Integer | Optional | Default value: 0 |
Example Request
[
{
"limit": 40,
"offset": 3
}
]Action: List Application Site Category
This action retrieves all the application site categories.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Limit | Enter the maximum number of application site categories you want as result. Example: 40 | Integer | Optional | Default value: 50 |
Offset | Enter the number of the results to skip initially on the list. Example: 3 | Integer | Optional | Default value: 0 |
Example Request
[
{
"limit": 40,
"offset": 3
}
]Action: Add Application Site Category
This action adds a new application site category.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the application site. The name must be unique in the domain. Example: "New Application Site Category" | Text | Required | |
Description | Enter the description of the application site category. Example: "My Application Site category" | Text | Optional | |
Groups | Enter the list of group identifiers for the application site category. Example: $LIST[Priority Group, Low Priority Group] | List | Optional |
Example Request
[
{
"name":"Sample Host",
"ip_address":"1.1.1.1",
"group_list":[
"Priority Group",
"Low Priority Group"
]
}
]Action: Get Application Site category
This action retrieves the existing object using the name.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the identifier to retrieve the application site category object. Example: "Social Networking" | Text | Required |
Example Request
[
{
"name": "Social Networking"
}
]Action: Delete Host
This action deletes a particular host.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the host to delete. Example: "New Host 1" | Text | Required |
Example Request
[
{
"name": "New Host 1"
}
]Action: Show Host
This action shows a particular host.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the host to show details. Example: "New Host" | Text | Required |
Example Request
[
{
"name": "New Host"
}
]Action: Publish All The Changes
This action publishes all the changes.
Action Input Parameters
This action does not require any input parameter.
Action: List Host
This action retrieves the list of all hosts.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Limit | Enter the maximum number of hosts you want as result. Example: 40 | Integer | Optional | Default value: 50 |
Offset | Enter the number of the results to skip initially on the list. Example: 3 | Integer | Optional | Default value: 0 |
Order | Enter the order in which you want the list to be displayed. Example: "asc" | Text | Optional | Allowed values:
|
Example Request
[
{
"limit": 40,
"offset": 3,
"order": "asc"
}
]Action: Update Host
This action updates the details of a host.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the host to be updated. Example: "New Host Name" | Text | Required | |
IP address | Enter the new IP address of the host to update. Example: "192.0.2.1" | Text | Optional | |
New name | Enter the new name of the host to update. Example: "Updated Host Name" | Text | Optional | |
Comment | Enter the comment to update. Example: "Host Name Updated" | Text | Optional | |
Ignore warning | Specify if you want to apply changes ignoring warnings. Example: $JSON[Yes/No] | Boolean | Optional | Allowed values:
Default value: Yes |
Ignore errors | Specify if you want to apply changes ignoring errors. Example: $JSON[Yes/No] | Boolean | Optional | Allowed values:
Default value: No |
Example Request
[
{
"name": "New Host Name",
"ip_address": "192.0.2.1",
"new_name": "Updated Host Name",
"comments": "Host Name Updated",
"ignore_warnings": True,
"ignore_errors": True
}
]Action: Show Group
This action shows details of a particular group.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Group name | Enter the name of the group to show details. Example: "Priority Group" | Text | Required | |
Show as ranges | Enter if you want to display the matched content of the group as ranges of IP addresses instead of network objects. Example: $JSON[Yes/No] | Boolean | Optional | Allowed values:
Default value: No |
Example Request
[
{
"group_name": "Priority Group",
"show_as_ranges": True
}
]Action: List Groups
This action retrieves the list of all hosts.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Limit | Enter the maximum number of groups you want as result. Example: 40 | Integer | Optional | Default value: 50 |
Offset | Enter the number of the results to skip initially on the list. Example: 3 | Integer | Optional | Default value: 0 |
Example Request
[
{
"limit": 40,
"offset": 3
}
]Action: Delete Group
This action deletes a particular group.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Group name | Enter the name of the group to delete. Example: "Priority Group" | Text | Required |
Example Request
[
{
"group_name": "Priority Group"
}
]Action: Add Group
This action adds a particular group.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Group name | Enter the name of the new group to add. Example: "New Group" | Text | Required | |
Members | Enter the name of the members to add to the group. Example: $LIST[Host 1, Host 2] | List | Optional |
Example Request
[
{
"name":"New Group",
"members":[
"Host 1",
"Host 2"
]
}
]Action: List Address Ranges
This action retrieves the list of all address ranges.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Limit | Enter the maximum number of address ranges you want as result. Example: 40 | Integer | Optional | Default value: 50 |
Offset | Enter the number of the results to skip initially on the list. Example: 3 | Integer | Optional | Default value: 0 |
Example Request
[
{
"limit": 40,
"offset": 3
}
]Action: Add Address Range
This action adds an address range.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the address range to add. Example: "New Address Range" | Text | Required | |
First IP address | Enter the first IP address in the range to add. Example: "192.0.2.1" | Text | Required | |
Last IP address | Enter the last IP address in the range to add. Example: "192.0.2.10" | Text | Required |
Example Request
[
{
"name": "New Address Range",
"first_ip_address": "192.0.2.1",
"last_ip_address": "192.0.2.10"
}
]Action: Delete Address Range
This action deletes a particular address range.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the address range to delete. Example: "Sample Address Range" | Text | Required |
Example Request
[
{
"name": "Sample Address Range"
}
]Action: Update Address Range
This action edits and updates the address range.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the host to update. Example: "New Address Range" | Text | Required | |
First IP address | Enter the first IP address in the range to update. Example: "192.0.2.1" | Text | Optional | |
Last IP address | Enter the last IP address in the range to update. Example: "192.0.2.10" | Text | Optional | |
New name | Enter the new name of the address range to update. Example: "Updated Address Range" | Text | Optional |
Example Request
[
{
"name": "New Address Range",
"first_ip_address": "192.0.2.1",
"last_ip_address": "192.0.2.10",
"new_name": "Updated Address Range"
}
]Action: Show Address Range
This action shows details of an address range.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the address range to show details. Example: "New Address Range" | Text | Required |
Example Request
[
{
"name": "New Address Range"
}
]Action: List Threat Indicators
This action is used to show list of all threat indicators.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Limit | Enter the maximum number of threat indicators you want as result. Example: 40 | Integer | Optional | Default value: 50 |
Offset | Enter the number of the results to skip initially on the list. Example: 3 | Integer | Optional | Default value: 0 |
Order | Enter the order in which you want the list to be displayed. Example: "asc" | Text | Optional | Allowed values:
|
Example Request
[
{
"limit": 40,
"offset": 3,
"order": "asc"
}
]Action: Show Threat indicator
This action shows the details of the threat indicators.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the threat indicator to show details. Example: "New Threat Indicator" | Text | Required |
Example Request
[
{
"name": "New Threat Indicator"
}
]Action: Delete Threat indicator
This action deletes a particular threat indicator.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the threat indicator to delete. Example: "Threat Indicator 1" | Text | Required |
Example Request
[
{
"name": "Threat Indicator 1"
}
]Action: Add Threat Indicator
This action adds a threat indicator.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the threat indicator to add. Example: "New Indicator Name" | Text | Required | |
First IP address | Enter the first IP address in the range to add. Example: "192.0.2.1" | Text | Required | |
Last IP address | Enter the last IP address in the range to add. Example: "192.0.2.10" | Text | Required | |
Name | Enter the name of the observables indicator. Example: "New Threat Indicators" | Text | Required | |
Action | Enter action performed by added indicator. Example: "inactive" | Text | Optional | Allowed values:
Default value: prevent |
Example Request
[
{
"name": "New Indicator Name",
"first_ip_address": "192.2.0.1",
"last_ip_address": "192.2.0.10",
"new_name": "New Observable Name",
"action": "inactive"
}
]Action: Update Threat Indicator
This action updates details of a threat indicator.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the threat indicator to be updated. Example: "New Indicator" | Text | Required | |
New Name | Enter the new name of the host to update. Example: "My Indicator" | Text | Optional | |
Action | Enter action performed by updated indicator. Example: "inactive" | Text | Optional | Allowed values:
Default value: prevent |
Profile | Enter the profile which overrides the action. Example: "My Profile" | Text | Optional | |
Remove Indicator | Enter the name of the existing indicator to remove. Example: "New Indicator" | Text | Optional | |
Comment | Enter the comment to update. Example: "Sample Comment" | Text | Optional |
Example Request
[
{
"name": "New Indicator",
"new_name": "My Indicator",
"action": "inactive",
"profile": "My Profile",
"remove_indicator": "New Indicator",
"comments": "Sample Comment"
}
]Action: List Access Rule
This action shows the entire access rules layer. An access rule may be within a section, or independent of a section.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the identifier. Example: "New Access Rule" | Text | Required | |
Limit | Enter the maximum number of access rules you want as result. Example: 40 | Integer | Optional | Default value: 50 |
Offset | Enter the number of the results to skip initially on the list. Example: 3 | Integer | Optional | Default value: 0 |
Example Request
[
{
"name": "New Access Rule",
"limit": 40,
"offset": 3
}
]Action: Update Access Rule
This action updates the details of an access rule.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the access rule to be updated. Example: "New Access Rule" | Text | Required | |
Layer | Enter the layer that the rule belongs to identified by the name. Example: "New Layer" | Text | Required | |
New Position | Enter the specific position for the rule. Example: "top" | Text | Optional | Allowed values:
|
New Name | Enter the new name of the access rule to update. Example: "Updated Access Rule Name" | Text | Optional | |
Action | Enter the action performed by the access rule. Example: "accept" | Text | Optional | Allowed values:
|
Example Request
[
{
"name": "New Access Rule",
"layer": "New Layer",
"new_position": "top",
"new_name": "Updated Access Rule Name",
"action": "accept"
}
]Action: Add Access Rule
This action adds the access rule.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Layer | Enter the layer for the rule. The rule will be identified by the name layer name. Example: "New Layer" | Text | Required | |
Position | Enter the position for the rule. Example: "top" | Text | Required | Allowed values:
|
Name | Enter the name of the access rule to be added. Example: "New Access Rule" | Text | Optional | |
Action | Enter the action performed by the access rule. Example: "Accept" | Text | Optional | Allowed values:
|
VPN | Enter one of the allowed values to receive one of the valid values or community name. Example: "Any" | Text | Optional | Allowed values:
|
Destination | Enter the collection of network objects identified by the name. Example: "Check Point Data" | Text | Optional | |
Service | Enter the collection of network objects identified by the name. Example: "New Service" | Text | Optional | |
Source | Enter the collection of network objects identified by the name. Example: "New Source" | Text | Optional |
Example Request
[
{
"layer": "New Layer",
"position": "Top",
"name": "New Access Rule",
"action": "Accept",
"vpn": "Any",
"destination": "Check Point Data",
"service": "New Service",
"source": "New Source"
}
]Action: Delete Access Rule
This action deletes an access rule.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the access rule to be deleted. Example: "New Access Rule" | Text | Required | |
Layer | Enter the layer that the rule belongs to identified by the name. Example: "Sample Layer" | Text | Required |
Example Request
[
{
"name": "New Access Rule",
"layer": "Sample Layer"
}
]Action: List Application Site
This action retrieves the list of all application sites.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Limit | Enter the maximum number of application sites you want as result. Example: 40 | Integer | Optional | Default value: 50 |
Offset | Enter the number of the results to skip initially on the list. Example: 3 | Integer | Optional | Default value: 0 |
Example Request
[
{
"limit": 40,
"offset": 3
}
]Action: Add Application Site
This action adds an application site.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the application site to add. Example: "New Application Site" | Text | Required | |
Primary Category | Enter the category to which application can be assigned based on its most defining aspect. Example: "Instant Category" | Text | Required | |
URL List | Enter the URLs that determine the application site. Example: $LIST[www.exampledomain.com, www.exampledomain1.com] | List | Required | |
Group | Enter the group details to create the application site. Example: $LIST[Site_group_1, Site_group_2] | List | Optional | |
Description | Enter the description for the application site. Example: "Sample Description" | Text | Optional |
Example Request
[
{
"name":"New Application Site",
"primary_category":"Instant Category",
"url_list":[
"www.exampledomain.com",
"www.exampledomain1.com"
],
"groups":[
"Site Group 1",
"Site Group 2"
],
"description":"Sample Description"
}
]Action: Update Application Site
This action updates details of an application site.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the application site to be updated. Example: "New Application Site" | Text | Required | |
Primary Category | Enter the category to which application can be assigned based on its most defining aspect. Example: "Instant Category" | Text | Optional | |
Description | Enter the description for the application. | Text | Optional | |
New Name | Enter the new name of the application site to update. Example: "Updated Application Site" | Text | Optional | |
URL List | Enter URLs that determine this particular application. Example: $LIST[www.exampledomain.com, www.exampledomain1.com] | List | Optional | |
Group | Enter the level of details in the output corresponding to the number of details for search. Example: $LIST[Site_Group_1, Site_Group_2] | List | Optional |
Example Request
[
{
"name":"New Application Site",
"primary_category":"Instant Category",
"description":"Sample Description",
"new_name":"Updated Application Site",
"url_list":[
"www.exampledomain.com",
"www.exampledomain1.com"
],
"groups":[
"Site Group 1",
"Site Group 2"
]
}
]Action: Install Policy
This action installs a policy.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Policy Package | Enter the name of the policy package to be installed. Example: "New Policy Package" | Text | Required | |
Target | Enter the targets to execute this command. Targets can be identified by their name. Example: $LIST[corporate-gateway, New Target] | List | Required | |
Access | Enter your preference to install the access control policy. Example: $JSON[Yes/No] | Boolean | Optional | Allowed values:
Default value: Yes |
Example Request
[
{
"policy_package":"New Policy Package",
"target":[
"corporate-gateway",
"New Target"
],
"access": True
}
]Action: Verify Policy
This action verifies the policy of the selected package.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Policy Package | Enter the name of the policy package to be verified. Example: "New Policy Package" | Text | Required |
Example Request
[
{
"policy_package": "New Policy Package"
}
]Action: Update Groups
This action edits and updates a group.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the host to be edited. Example: "New Group" | Text | Required | |
New Name | Enter the new name of the host to update. Example: "Updated Group Name" | Text | Optional | |
Add Member | Enter the name of the new member to add. Example: "New Member" | Text | Optional | |
Remove Member | Enter the name of the member to remove. Example: "SOC Member" | Text | Optional | |
Comment | Enter the comment to update. Example: "Sample Comment" | Text | Optional |
Example Request
[
{
"name": "New Group",
"new_name": "Updated Group Name",
"add_members": "New Member",
"remove_members": "SOC Member",
"comments": "Sample Comment"
}
]Action: Delete Application Site
This action deletes the application site.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the application site to delete. Example: "New Application Site" | Text | Required |
Example Request
[
{
"name": "New Application Site"
}
]Action: Show Object
This action retrieves the data about objects.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Limit | Enter the maximum number of objects you want as result. Example: 40 | Integer | Optional | Default value: 50 |
Offset | Enter the number of the results to skip initially on the list. Example: 3 | Integer | Optional | Default value: 0 |
Example Request
[
{
"limit": 40,
"offset": 3
}
]Action: Get the list of Networks
This action retrieves the list of networks.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Limit | Enter the maximum number of networks you want as result. Example: 40 | Integer | Optional | Default value: 50 |
Offset | Enter the number of the results to skip initially on the list. Example: 3 | Integer | Optional | Default value: 0 |
Example Request
[
{
"limit": 40,
"offset": 3
}
]