Creating a simple access rule via API

Jon_Pahl1 — Wed, 30 Jun 2021 20:10:26 GMT

For this document we will assume that only the protocol objects and basic policy have been created.

Current policy

Current layers in the default policy

Create source and destination objects.
1. Creating a destination host object

Using the API call add host we have 1 required filed, Name, and require and ip address v4 or v6 via ip-address, ipv4-address or ipv6-address.

Optional fields include

Tags = collection of tag identifiers

Host-servers = servers configuration

Nat-setting

Interfaces

Groups

Color

Comments

Don’t forget to publish

Mgmt_cli publish

Creating a source network object

Using the API call ‘add network’ we create a simple network object. Again we have some required fields and we find the same ipv4 and v6 options as the ‘add host’ call.

Argument	Require	Description
Name	Yes	Object name
Subnet	Yes / or #1	IPv4 or IPv6 address
Subnet4	Yes / or #1	IPv4 address
Subnet6	Yes / or #1	IPv6 address
Mask-length	Yes / or #2	IPv4 or IPv6 cidr mask length
Mask-length4	Yes / or #2	IPv4 mask length
Mask-length6	Yes / or #2	IPv6 mask length
Nat-setting	No
Tags	No	Collection of tag identifiers
Broadcast	No	Option to allow broadcast inclusion
Color	No
Comments	No
Groups	No	Any group memberships

Example

Adding an access rule

The rule we are going to create is one to allow SSH and HTTPS to the target server defined earlier from the network we just created. Given the number of API arguments I am simple going to refer to the reference guide. https://sc1.checkpoint.com/documents/latest/APIs/index.html#cli/add-access-rule~v1.7.1%20

Example output

And the full API command in txt:

mgmt_cli add access-rule layer "Network" position "top" name "SSH & HTTPS access to test host" action "Accept" destination "Test-Host-1" source "Admin_network" service.1 "SSH" service.2 "HTTPS"

Finally the finished rule.

Use cases:

Lab setup
New application onboarding
Creating your own API process.
1. Some Check Point customers have created their own process they build host and network objects create rules all via a home grown web service.

topic Creating a simple access rule via API in API / CLI Discussion

Creating a simple access rule via API