REST API
You can use CloudGuard programmatically, with the REST API
Also known as RESTful API - an application programming interface (API or web API) that conforms to the constraints of REST architectural style and allows for interaction with RESTful web services., to onboard accounts, manage security groups, retrieve findings, and run posture assessments. Application developers can get access to these functions with RESTful HTTP requests. The resources and methods listed in the API include the CloudGuard functionality that the application developers need to onboard and manage the environments in CloudGuard.
The resource groups are CloudGuard resources and Inventory resources. CloudGuard resources include functional features (Intelligence, Compliance/Posture Management, Alerts), and entities (access leases, rulesets, and rules, CloudGuard users and roles). Inventory resources include entities such as Security Groups, instances, regions, and VPCs.
The API is based on HTTP requests and responses and uses JSON JavaScript Object Notation. A lightweight data interchange format. blocks.
The base URL for the CloudGuard API depends on your Data Center location (Settings > Account Info):
-
United States:
-
Europe:
-
Australia:
-
Canada:
-
India:
For the full API reference guide, see https://docs.cgn.portal.checkpoint.com/reference. All examples in the reference guide use the base URL for the United States as a default.