Working with Gaia RESTful API

Note - For additional API references, go to Check Point API Reference.

API Overview

Gaia 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 or Gaia Clish 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 Gaia operating system.

  • Use the Check Point "mgmt_cli.exe" command in the SmartConsole 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:

https://<IP Address or Gaia Management Interface>/gaia_docs/#introduction

Example:

https://192.168.3.57/gaia_docs/#introduction

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 / 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:

https://<IP Address or Gaia Management Interface>/api_docs/#introduction

Example:

https://192.168.3.57/api_docs/#introduction

Note - The local API reference is not updated with textual corrections through hotfixes, unless they are critical.