Check Point API Reference

https://sc1.checkpoint.com/documents/latest/api_reference
Admin
Check Point API Reference provides comprehensive documentation for a variety of APIs including...
Tokens:3,560
Snippets:23
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Smart-1 Cloud API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

REST API to run Smart-1 Cloud operations, such as: register a gateway and get the service information.

```APIDOC
## Smart-1 Cloud API

### Description
REST API to run Smart-1 Cloud operations, such as: register a gateway and get the service information.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/smart-1-cloud

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### Email Security API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

REST API to get security events and act on them, as well as to filter through protected emails, files and messages.

```APIDOC
## Email Security API

### Description
REST API to get security events and act on them, as well as to filter through protected emails, files and messages.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/email-security

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### Zero Touch API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

Use these REST APIs to automate the initial deployment of new GAiA and GAiA embedded appliances.

```APIDOC
## Zero Touch API

### Description
Use these REST APIs to automate the initial deployment of new GAiA and GAiA embedded appliances.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/zero-touch

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### GAiA API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

Configure and view Check Point’s Gaia operating system parameters using CLI tools and web-services.

```APIDOC
## GAiA API

### Description
Configure and view Check Point’s Gaia operating system parameters using CLI tools and web-services.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/gaia

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### Connect API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

REST API for managing cloud-delivered security for your branch offices.

```APIDOC
## Connect API

### Description
REST API for managing cloud-delivered security for your branch offices.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/connect

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### Spark Management API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

REST APIs of Management Cloud Service for Quantum Spark gateways.

```APIDOC
## Spark Management API

### Description
REST APIs of Management Cloud Service for Quantum Spark gateways.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/spark-management

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### Check Point Portal API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

View and configure your accounts, users, services & licenses at the Check Point Portal, Check Point's unified platform for managing you and your customers' security across all networks, cloud and mobile.

```APIDOC
## Check Point Portal API

### Description
View and configure your accounts, users, services & licenses at the Check Point Portal, Check Point's unified platform for managing you and your customers' security across all networks, cloud and mobile.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/portal

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### Mobile Security API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

View and configure Mobile Security users, devices and device groups, connect to MDM/UEM, retrieve security event from 3rd parties and more.

```APIDOC
## Mobile Security API

### Description
View and configure Mobile Security users, devices and device groups, connect to MDM/UEM, retrieve security event from 3rd parties and more.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/mobile-security

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### IoT Security API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

Connect your discovery engine to Check Point Security Management, to provide rich asset information and security policies for IoT Security.

```APIDOC
## IoT Security API

### Description
Connect your discovery engine to Check Point Security Management, to provide rich asset information and security policies for IoT Security.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/iot-security

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### WAF Application Security API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

Automate your Web Application & API security WAF Application Security powered by machine-learning. Stop OWASP-Top-10 as well as zero-day attacks.

```APIDOC
## WAF Application Security API

### Description
Automate your Web Application & API security WAF Application Security powered by machine-learning. Stop OWASP-Top-10 as well as zero-day attacks.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/waf-application-security

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### Cloud Firewall API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

Access resources and functionalities of CSPM, Intelligence, Serverless, Workload Protection and Shift Left (Spectral) as well as cloud asset inventory.

```APIDOC
## Cloud Firewall API

### Description
Access resources and functionalities of CSPM, Intelligence, Serverless, Workload Protection and Shift Left (Spectral) as well as cloud asset inventory.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/cloud-firewall

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### Management API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

Configure and view the security policy and objects in a Security Management Server or Multi Domain Server using CLI tools and web-services.

```APIDOC
## Management API

### Description
Configure and view the security policy and objects in a Security Management Server or Multi Domain Server using CLI tools and web-services.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/management

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### SASE API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

Create, manage, and control various aspects of your network security infrastructure. Using this API, you can automate routine tasks, enhance your security posture, and streamline your network management processes.

```APIDOC
## SASE API

### Description
Create, manage, and control various aspects of your network security infrastructure. Using this API, you can automate routine tasks, enhance your security posture, and streamline your network management processes.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/sase

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### Playblocks API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

APIs to manage and operate Playblocks, a security automation and response platform, offering out-of-the-box oriented playbooks, that are automatically triggered upon attack detection, and operational related incidents, to contain threats and prevent future attacks, always keeping the SOC team alerted and informed.

```APIDOC
## Playblocks API

### Description
APIs to manage and operate Playblocks, a security automation and response platform, offering out-of-the-box oriented playbooks, that are automatically triggered upon attack detection, and operational related incidents, to contain threats and prevent future attacks, always keeping the SOC team alerted and informed.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/playblocks

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### Identity Awareness API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

Control Identity Awareness database for dynamic identity based enforcement.

```APIDOC
## Identity Awareness API

### Description
Control Identity Awareness database for dynamic identity based enforcement.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/identity-awareness

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### IoC Management API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

API for managing Indicators of Compromise (IoC).

```APIDOC
## IoC Management API

### Description
API for managing Indicators of Compromise (IoC).

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/ioc-management

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### Events & AIOps API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

REST APIs to query security event logs generated by Check Point products that are included in Events & AIOps.

```APIDOC
## Events & AIOps API

### Description
REST APIs to query security event logs generated by Check Point products that are included in Events & AIOps.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/events-aiops

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### Threat Hunting API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

Query Threat Hunting and retrieve information about events reported by your devices. You can customize your query with various search options.

```APIDOC
## Threat Hunting API

### Description
Query Threat Hunting and retrieve information about events reported by your devices. You can customize your query with various search options.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/threat-hunting

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### CME API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

REST APIs for configuring the Cloud Management Extension (CME) for integrating between Cloud Firewall Network solutions and cloud platforms.

```APIDOC
## CME API

### Description
REST APIs for configuring the Cloud Management Extension (CME) for integrating between Cloud Firewall Network solutions and cloud platforms.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/cme

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### Endpoint Security API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

REST APIs to manage Endpoint assets and respond to Endpoint security incidents.

```APIDOC
## Endpoint Security API

### Description
REST APIs to manage Endpoint assets and respond to Endpoint security incidents.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/endpoint-security

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### Threat Prevention API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

Cloud based next-generation Threat Prevention and Threat Extractions APIs.

```APIDOC
## Threat Prevention API

### Description
Cloud based next-generation Threat Prevention and Threat Extractions APIs.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/threat-prevention

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```

--------------------------------

### XDR API

Source: https://sc1.checkpoint.com/documents/latest/api_reference/index.html

REST APIs to query Check Point XDR data, returns information about incidents and their forensic data.

```APIDOC
## XDR API

### Description
REST APIs to query Check Point XDR data, returns information about incidents and their forensic data.

### Method
GET, POST, PUT, DELETE (specific methods depend on the operation)

### Endpoint
/api/v1/xdr

### Parameters
(Specific parameters depend on the operation. Refer to the API spec for details.)

### Request Example
(Refer to the API spec for request examples)

### Response
(Specific response fields depend on the operation. Refer to the API spec for details.)

### Response Example
(Refer to the API spec for response examples)
```
Tokens:
Raw