Working with Gaia RESTful API
|
|
Note - For additional API references, go to Check Point API Reference. |
API Overview
Gaia
Check Point security operating system that combines the strengths of both SecurePlatform and IPSO operating systems. RESTful API provides a way to read information and to send commands to the Check Point Gaia Operating System.
Just like it is possible to use Gaia Portal Web interface for the Check Point Gaia operating system. or Gaia Clish The name of the default command line shell in Check Point Gaia operating system. This is a restricted shell (role-based administration controls the number of commands available in the shell). commands to work with Gaia, it is possible to do the same using API commands.
|
|
Note - Gaia API does not yet support the configuration of all Gaia OS settings. |
Running the Gaia API Commands
-
Use a 3rd-party API client to send API commands over an HTTPS connection.
-
Use the Check Point "
mgmt_cli" command in the Expert mode on the Gaiaoperating system. -
Use the Check Point "
mgmt_cli.exe" command in the SmartConsole Check Point GUI application used to manage a Check Point environment - configure Security Policies, configure devices, monitor products and events, install updates, and so on. installation folder.
Online Gaia API Reference
See the Check Point Gaia API Reference.
|
|
Note - The online API reference is updated from time to time with textual corrections. |
Local Gaia API Reference
In a web browser, connect to:
|
|
Example:
|
|
|
|
Note - The local API reference is not updated with textual corrections through hotfixes, unless they are critical. |
Local Management API Reference
This local Management API reference exists on a Security Management Server Dedicated Check Point server that runs Check Point software to manage the objects and policies in a Check Point environment within a single management Domain. Synonym: Single-Domain Security Management Server. / Multi-Domain Security Management Server Check Point Single-Domain Security Management Server or a Multi-Domain Security Management Server..
|
|
Important - First, you must follow sk174606 to allow access this local Management API reference. |
In a web browser, connect to:
|
|
Example:
|
|
|
|
Note - The local API reference is not updated with textual corrections through hotfixes, unless they are critical. |