Managing Security through API

This section describes the API Server on a Management Server and the applicable API Tools.

API

You can configure and control the Management Server through API Requests you send to the API Server that runs on the Management Server.

The API Server runs scripts that automate daily tasks and integrate the Check Point solutions with 3rd-party systems, such as virtualization servers, ticketing systems, and change management systems.

To learn more about the management APIs, to see code samples, and to take advantage of user forums, see:

  • The API Documentation:

    • Online - Check Point Management API Reference (at the top, select the correct version)

    • Local - https://<IP Address of Management Server>/api_docs

      By default, access to the local API Documentation is disabled. Follow the instructions in sk174606.

      Note - On a Standalone server (a server which runs both a Security Management Server and a Security Gateway), the API Documentation web portal (https://<IP Address of Management Server>/api_docs) stops working when you open SmartView Web Application (https://<IP Address of Management Server>/smartview).

  • The Developers Network section of Check Point CheckMates Community.

API Tools

You can run the required API commands on the Management Server in these ways:

  • From the Command Line dialog in the SmartConsole GUI application (bottom left corner).

  • From the command line on the Management Server with the "mgmt_cli" command in the Expert mode.

  • From the command line on the Management Server with the "mgmt" command in Gaia Clish.

  • From the command line on the SmartConsole client host with the "mgmt_cli.exe" tool (installed as part of SmartConsole for Windows OS).

Configuring the API Server

To configure the API Server:

  1. Connect with SmartConsole to the Security Management Server or applicable Domain Management Server.

  2. From the left navigation panel, click Manage & Settings.

  3. In the upper left section, click Blades.

  4. In the Management API section, click Advanced Settings.

    The Management API Settings window opens.

  5. Configure the Startup Settings and the Access Settings.

    Select Automatic start to automatically start the API server when you start or reboot the Management Server.

    Notes:

    • If the Management Server has more than 4GB of RAM installed, the Automatic start option is activated by default during the Management Server installation.

    • If the Management Server has less than 4GB of RAM, the Automatic start option is deactivated.

    Select one of these options to configure which clients can connect to the API Server:

    • Management server only

      Only the Management Server itself can connect to the API Server.

      This option only lets you use the mgmt_cli utility on the Management Server command line to send API requests.

      You cannot use SmartConsole or Web services to send API requests.

    • All IP addresses that can be used for GUI clients

      You can send API requests from all IP addresses that are defined in SmartConsole > Permissions & Administrators > Trusted Clients.

      This includes requests from SmartConsole, Web services, and the mgmt_cli utility on the Management Server.

    • All IP addresses

      You can send API requests from all IP addresses.

      This includes requests from SmartConsole, Web services, and the mgmt_cli utility on the Management Server.

  6. Click OK.

  7. In the upper left section, click Permissions & Administrators.

  8. In the object of each applicable Administrator, make sure the assigned Permission Profile allows access to Management API.

    1. Edit the Administrator object.

    2. In the left panel, click General.

    3. In the Permissions section, on the right side of the selected Permission Profile, click the eye icon.

      The Permission Profile object opens in the read-only view.

    4. In the left panel, click Management.

    5. The permission Management API Login has to be selected.

      If it is not selected, then close this window and edit this Permission Profile object.

    6. Click Close.

  9. Publish the SmartConsole session.

  10. Restart the API Server on the Management Server with this command:

    api restart

    Notes:

    • On a Multi-Domain Server, you must run this command in the context of the applicable Domain Management Server:

      mdsenv <IP Address or Name of Domain Management Server>

    • The output of this command must show:

      API started successfully

  11. Examine the status of the API server on the Management Server with this command:

    api status

    Notes:

    • The output of this command must show:

      --------------------------------------------
Overall API Status: Started
--------------------------------------------

API readiness test SUCCESSFUL. The server is up and ready to receive connections

    • The output this command may show the state of the "API" process as "Stopped" when the API access is set to "All IP addresses that can be used for GUI clients", and more than 200 Trusted Clients are configured:

      Processes:

Name      State     PID       More Information
-------------------------------------------------
API       Stopped   ...