0% found this document useful (0 votes)
39 views6 pages

Check Point APIs Reference Guide R80

The Check Point APIs Reference Guide R80 provides system administrators and developers with tools to manage security policies through various APIs, including R80 Management API, Threat Prevention API, and OPSEC SDK. It outlines procedures for making API calls via SmartConsole CLI, mgmt_cli, Gaia CLI, and web services, along with sample commands for each API. Additionally, it introduces Identity Awareness APIs and Threat Prevention Intelligence API, which are planned for future releases.
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
39 views6 pages

Check Point APIs Reference Guide R80

The Check Point APIs Reference Guide R80 provides system administrators and developers with tools to manage security policies through various APIs, including R80 Management API, Threat Prevention API, and OPSEC SDK. It outlines procedures for making API calls via SmartConsole CLI, mgmt_cli, Gaia CLI, and web services, along with sample commands for each API. Additionally, it introduces Identity Awareness APIs and Threat Prevention Intelligence API, which are planned for future releases.
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

26 May 2016

Check Point APIs

R80

Reference Guide
Classification: [Protected]
© 2016 Check Point Software Technologies Ltd.
All rights reserved. This product and related documentation are protected by copyright and
distributed under licensing restricting their use, copying, distribution, and decompilation. No part
of this product or related documentation may be reproduced in any form or by any means without
prior written authorization of Check Point. While every precaution has been taken in the
preparation of this book, Check Point assumes no responsibility for errors or omissions. This
publication and features described herein are subject to change without notice.
RESTRICTED RIGHTS LEGEND:
Use, duplication, or disclosure by the government is subject to restrictions as set forth in
subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS
252.227-7013 and FAR 52.227-19.
TRADEMARKS:
Refer to the Copyright page [Link] for a list of our
trademarks.
Refer to the Third Party copyright notices [Link]
for a list of relevant copyrights and third-party licenses.
Introducing Check Point APIs

Introducing Check Point APIs


Check Point APIs let system administrators and developers make changes to the security policy
with CLI tools and web-services. You can use an API to:
 Use an automated script to perform common tasks
 Integrate Check Point products with 3rd party solutions
 Create products that use and enhance the Check Point solution

Check Point APIs Reference Guide R80 | 3


Overview

Overview
R80 Management API
R80 Security Management Servers support hundreds of API calls to let you perform many tasks
that are usually done with the SmartConsole. These are the procedures you can use to make API
calls:
 SmartConsole CLI - From SmartConsole, you can open a CLI window end enter API commands
 mgmt_cli Tool - Runs in Expert mode and lets you enter commands from a Windows or Linux
computer
Note - You must enter the username and password with the mgmt_cli tool procedure
 Gaia CLI - Log in to the Gaia operating system with an administrator account on the Security
Management Server and enter API commands
 Web Services - Send HTTPS Post requests to the Security Management Server
For more about how to use the R80 Management API, go to the Check Point Community
[Link] and see the Management API Reference
[Link]

Sample Command with SmartConsole CLI


You can use the add host command to create a new host and then publish the changes.
> add host name "Sample_Host" ip-address "[Link]"
> publish

R77 Threat Prevention API


The Check Point Threat Prevention Web Service API lets you control these Threat Prevention
products:
 Threat Emulation
 Anti-Virus
 Threat Extraction
The Threat Prevention API is a cloud service, with dynamic updates for feature extensions. This
API uses JSON requests and responses for functionality similar to NGTX and TX appliances.
For more how to use the R77 Threat Prevention API, see the Threat Prevention API Reference
Guide [Link]

Check Point APIs Reference Guide R80 | 4


Overview

Sample Command of the Threat Prevention API:


This is an example Request to send a web service query to the databases for Threat Emulation and
Anti-Virus results of the file with the specified MD5 signature. The query outputs the results to
XML and PDF formats, for Threat Emulation, on all the supported images.
{
"request": [
{
"md5": "8dfa1440953c3d93daafeae4a5daa326",
"features": [
"te",
"av"
],
"te": {
"reports": [
"xml",
"pdf"
]
}
}
]
}

OPSEC SDK
The OPSEC SDK contains APIs for commands that were originally used with SecurePlatform. You
can also use these commands on the Gaia operating system. The OPSEC APIs can open and
monitor connections between the Security Management Server and gateways and other hosts and
objects. The OPSEC SDK is very powerful and accesses the tables in the Security Management
Server database.
For more about how to use the OPSEC SDK, go to sk63026
[Link]

Sample Command with OPSEC SDK


You can use the cp_conf sic state command to show the SIC status for a gateway or host.
> cp_conf sic state
Output - Trust State: Trust established

Check Point APIs Reference Guide R80 | 5


Overview

Identity Awareness Web Services APIs


The Identity Awareness Web Services APIs lets you use REST protocol over HTTPS to add, remove,
and show the status of these identity parameters:
 User name
 IP address
 Computer name
 SmartConsole user groups
 Identity Awareness Access Roles
For example, you can use the API to add a new user to an Access Role, or allow a user to connect
to the internal network from a different IP address.
Check Point is planning to release the Identity Awareness APIs with R80.10.

Threat Prevention Intelligence API


You can use Custom Indicators to identify malicious activity related to the Check Point Threat
Prevention Software Blades. Anti-Virus and Anti-Bot use this information to detect and prevent
malicious activity based on your indicators.
An API for this feature is planned for a version after R80.10.

Check Point APIs Reference Guide R80 | 6

Common questions

Powered by AI

The Threat Prevention Web Service API primarily provides control over Threat Prevention products like Threat Emulation, Anti-Virus, and Threat Extraction. The advantage lies in its cloud-based infrastructure, which allows dynamic updates for feature extensions, supporting flexibility and up-to-date threat management. The API's use of JSON requests and responses ensures efficient interaction with services like NGTX and TX appliances .

Planned Identity Awareness APIs for versions after R80.10 are expected to significantly impact security management by enhancing identity-based security controls. These APIs could improve the granularity of access management, allowing for more dynamic and contextual identity verification processes. The enhancement would likely lead to more efficient management of identities across distributed network environments, increasing overall network security and compliance with identity management policies .

Custom Indicators in the Threat Prevention Intelligence API enable the identification of malicious activity tailored to specific organizational environments by leveraging unique indicators defined by users. This targeted approach enhances Anti-Virus and Anti-Bot functionalities, as these tools can employ the custom indicators to detect and preemptively respond to threats, thereby refining both detection precision and response time in preventing potential breaches .

Check Point APIs provide system administrators and developers with tools to manage security policies through CLI tools and web-services. They enable automation of routine tasks, integration with third-party solutions, and development of products that enhance Check Point solutions. Administrators can use the SmartConsole CLI, mgmt_cli tool, and Gaia CLI to execute API commands, facilitating efficient security management .

The Threat Prevention API shares functionality with NGTX and TX appliances, such as threat emulation and antivirus capabilities, managed through JSON requests and responses. This resemblance allows for seamless integration within existing security frameworks, providing consistent threat management processes across different platforms. The API's ability to emulate appliance features ensures comprehensive threat detection and response capabilities within cloud-based infrastructures .

The dynamic updates in the Threat Prevention API enhance its operational efficiency by ensuring that the API is always using the latest threat intelligence and protection features, reducing lag time between new threats emerging and the system's ability to respond. This ensures optimal performance and security capability, allowing for real-time adaptation to new vulnerabilities and threats, driven by continuous, automated updates .

Check Point APIs allow automation of tasks such as policy updates, security monitoring, and user management, which are typically manual and time-consuming. Automation supports organizational security objectives by streamlining processes, reducing human error, and ensuring rapid response to security incidents. This not only enhances the efficiency of IT operations but also strengthens the organization's overall security posture .

The OPSEC SDK can be utilized to monitor connections by leveraging APIs originally used with SecurePlatform, now applicable to the Gaia operating system. These APIs allow for the opening and monitoring of connections between the Security Management Server and various gateways and hosts. By accessing Security Management Server database tables, it enables comprehensive oversight of connection states and SIC status, as exemplified by commands like 'cp_conf sic state' .

The R80 Management API facilitates performing tasks typically executed via the SmartConsole by offering multiple access methods: SmartConsole CLI for direct API command entry, the mgmt_cli tool accessible in Expert mode on Windows or Linux requiring authentication credentials, Gaia CLI on the Security Management Server, and Web Services through HTTPS POST requests to the server. This flexibility enhances task automation and integration capabilities .

The Identity Awareness Web Services APIs offer functionalities to add, remove, and monitor identity parameters, such as user names, IP addresses, and smart console user groups, using REST protocol over HTTPS. These APIs enhance network security by allowing for real-time updates and management of identity-based access controls, thus ensuring that security policies remain aligned with current user roles and identities within the organization .

You might also like