topic Re: Request for API Documentation and Guidance for Access Rules on Checkpoint Devices in API / CLI Discussion

Request for API Documentation and Guidance for Access Rules on Checkpoint Devices

Veeraselvam_man — Fri, 26 Jul 2024 05:08:45 GMT

Hi all,

I'm seeking assistance on how to retrieve access rules information from the Physical Checkpoint Router and Checkpoint Firewall 1590 Appliance using API.

Could you please provide the API documentation and any necessary steps or guidance? This will help me access the rule information effectively.

Thank you!

M.Veeraselvam.

Re: Request for API Documentation and Guidance for Access Rules on Checkpoint Devices

Daniel_Kuhl1 — Fri, 26 Jul 2024 08:10:16 GMT

Hi @Veeraselvam_man,

on the link below you will find the landing page for the Check Point API references: Check Point - API Reference

For your specific case, take a look at the Spark Management API reference if centrally managed from the Infinity portal or look at the Locally Managed Administration Guide to use the RESTful API on the device.

Let us know here if you need further help to get started.

Daniel

Re: Request for API Documentation and Guidance for Access Rules on Checkpoint Devices

Veeraselvam_man — Sat, 27 Jul 2024 16:32:22 GMT

@Daniel_Kuhl1 , Could you please share which API is applicable for the Checkpoint Router and Checkpoint Firewall 1590 Appliance? I can't seem to find the exact one.

M.Veeraselvam

Re: Request for API Documentation and Guidance for Access Rules on Checkpoint Devices

PhoneBoy — Sat, 27 Jul 2024 19:44:37 GMT

It's the run-clish-command endpoint described here: https://sc1.checkpoint.com/documents/SMB_R81.10.X/AdminGuides_Locally_Managed/EN/Content/Topics/RESTful-API.htm?tocpath=_____19
The various clish commands you can run are documented here: https://sc1.checkpoint.com/documents/SMB_R81.10.X/CLI/EN/Content/Topics/CLI-Syntax.htm

Re: Request for API Documentation and Guidance for Access Rules on Checkpoint Devices

Veeraselvam_man — Mon, 29 Jul 2024 05:06:27 GMT

Thank you @PhoneBoy , From your input, it seems the REST API access documentation you shared is applicable to both the physical Checkpoint Router and the Checkpoint Firewall 1590 Appliance. Is this correct?https://sc1.checkpoint.com/documents/SMB_R81.10.X/AdminGuides_Locally_Managed/EN/Content/Topics/RESTful-API.htm?tocpath=_____19

M.Veeraselvam

Re: Request for API Documentation and Guidance for Access Rules on Checkpoint Devices

PhoneBoy — Mon, 29 Jul 2024 12:18:25 GMT

Yes, because clish is used to manage both elements on locally managed SMB appliances.

Re: Request for API Documentation and Guidance for Access Rules on Checkpoint Devices

Veeraselvam_man — Tue, 30 Jul 2024 05:21:45 GMT

Here is the revised text:

Thank you @PhoneBoy , I want to retrieve the access rules and the corresponding network and service objects from the Checkpoint Router and the Checkpoint Firewall 1590 Appliance. How can I obtain this information using the REST API? Please provide the API commands along with the REST API documentation.

M.Veeraselvam

Re: Request for API Documentation and Guidance for Access Rules on Checkpoint Devices

PhoneBoy — Tue, 30 Jul 2024 14:05:14 GMT

It is covered in the links I've already provided you.
Here's a screenshot of the API call format:

If you're wanting a simple dump of the rules in a viewable format, you need the following two clish commands:

show access-rules type incoming-internal-and-vpn
show access-rules type outgoing

For full details, then you need the output of "show configuration" which will give you everything (including the router and access policy configuration).
The actual commands sent in the API call must be base64 encoded, as described in the documentation.