topic Re: Management API Web Interface for Check Point R80.20 for API version 1.3 in API / CLI Discussion

Management API Web Interface for Check Point R80.20 for API version 1.3

Charles_Currier — Fri, 30 Nov 2018 13:43:26 GMT

DESCRIPTION This is a Docker Containerized "Tree View Menu Tool".
It is a Python/Apache powered web page representation of the Check Point Management API v1.3.
More to the point it is a WYSIWYG interface of all the commands available in the Check Point
Management API. A valid login to a Check Point R80.20 MDS or SmartCenter with the API enabled
is required. Once logged in the API commands will be loaded on the left side of the page. The
commands are organized into a tree menu. Double Clicking will open a "category" or "branch"
of commands. Single clicking on a command will load the command and commands options onto the right
side of the page. Submitting there will pass the API command to the Management Server.

Codebase is also available through GitHub - cbcurrier3/wapi: Web interface to Check Point Management API


BUILD
#docker build -rm -t wapi wapi/
#docker volume create --name=cpdata --opt type=nfs --opt=device=:/home/ovirt/cpData --opt=o=addr=192.168.0.245

RUN
# docker run -d -p 8080:443 --restart=always --name wapi wapi
# docker run -d -p 80:80 -p 443:443 --restart=always -v cpdata:/mnt/cpdata --name wapi wapi

EXEC
Bash #docker exec -i -t wapi bash

EXPRESS
docker build --rm -t wapi . ; docker run -d -p 80:443 --restart=always --name wapi wapi; docker exec -i -t wapi bash

CONFIGURE
set permissions and servers to connect to from apps.
[root@dockerhost /]# docker exec -i -t wapi bash
EDIT
the following
[root@cp-api /]# vi /var/www/html/CP-API/incl/auth
server='192.168.10.100'
muser='apiuser'
mpass='CpR0cks!'
mport='443'
domain='Default'
session=''
Be sure you have in your management policy an access layer that has the name "Live_Demo" for instance.
COLLABORATION
There are still refinements to be made and any contributions are welcome.
OPEN SOURCE/LICENSE
The GNU License is included - the codebase is wholly open source but nothing herein grants any license, authority,
ownership to Check Point Software Tech API or other Check Point products, solutions or publications.

Re: Management API Web Interface for Check Point R80.20 for API version 1.3

Tomer_Sole — Fri, 30 Nov 2018 15:50:36 GMT

Hi, looks interesting.

Would you mind sharing more example screenshots?

Re: Management API Web Interface for Check Point R80.20 for API version 1.3

PhoneBoy — Fri, 30 Nov 2018 17:25:03 GMT

Agree, more screenshots, please

Re: Management API Web Interface for Check Point R80.20 for API version 1.3

Charles_Currier — Fri, 30 Nov 2018 18:06:17 GMT

Some additional screen shots.

Here is the Login Screen

This is a shot with the Tree Open:

Show - Request:

Show List:

Add Host:

I will look to generate a video tour in the near future.

Re: Management API Web Interface for Check Point R80.20 for API version 1.3

Vladimir — Wed, 05 Dec 2018 16:15:28 GMT

Could the resultant strings be displayed on the bottom of the page?

This looks very helpful and if the section detailing scrolling history of the calls is included on the bottom, will simplify compilation of the scripts for subsequent editing and reuse.

Re: Management API Web Interface for Check Point R80.20 for API version 1.3

Ron_Izraeli — Tue, 29 Jan 2019 05:52:10 GMT

Check out SmartConsole Extensions platform to integrate web pages inside SmartConsole

Re: Management API Web Interface for Check Point R80.20 for API version 1.3

Charles_Currier — Tue, 29 Jan 2019 14:33:59 GMT

Thanks Ron !
I think the SmartConsole Extensions will have an excellent impact.

At this time I am still getting my head around them.
The SmartConsole Extension Developer Guide is definitely the best starting place.

The thing I found that made doing something like the above tool easier was leveraging the API JSON file for Postman.

Exporting it from Postman provided a cleaned-up reference I was easily able to import into Python and think can be leveraged the same way for the Extensions.

The next challenge will simply be tying it all together.