Check Point - GAIA API reference

Introduction to Check Point GAIA API

Overview

GAIA API provides a new way to read information and to send commands to Check Point's servers. Just like it is possible to use the CLISH or commands from Expert mode, it is now possible to do the same using command line tools and through web-services.

Target audience

The GAIA API was created with the following target audiences in mind:

• System administrators who wish to improve their productivity by scripting some of their daily tasks.
• Customers who wish to integrate the Check Point solution with other solutions that they have (virtualization servers, ticketing systems, change management systems, etc.).
• Check Point partners and integrators that look for an easy to use API that can help them create complementary products around the Check Point solution.

Installation

The GAIA APIs can be installed on any R80.10 (or newer) server.

Using the GAIA APIs

There are two ways to communicate with the GAIA APIs:

1. Typing API commands using the "mgmt_cli" executable (available in both Windows, Linux/Gaia flavors).
2. Sending API commands over an https connection using web-services

Procedure to open the local Gaia API Reference:

1. In your web browser, go to:

       https://<IP_Address_of_Gaia_Management_Interface>/gaia_docs/#introduction

Example:

       https://192.168.3.57/gaia_docs/#introduction

Notes:

• If you connect to a Security Gateway, then make sure to allow this HTTPS connection in the Access Control Policy.
• If you connect to this Gaia server through a firewall, then make sure to allow this HTTPS connection.

2. The web browser shows this error because Gaia OS presents a self-signed certificate:

   ERR_CERT_AUTHORITY_INVALID

3. Click Advanced
4. Click Continue

Generating Documentation...