Zero Touch REST API Overview

In This Section: Request Structure Response Structure

This API is a way to read information and send commands to the Zero Touch server. Operations that are available through the Zero Touch GUI are available through web-services, with HTTPS Post requests to the Zero Touch server.

Request Structure

HTTP Post

https://zerotouch.checkpoint.com/ZeroTouch/web_api/v2/<command>

HTTP Headers

content-Type: application/json

X-chkp-sid: <session ID token ("sid") as returned by the login command>

The X-chkp-sid header is mandatory in all API calls except the login API.

Request payload

Text in JSON format containing the different parameters.

Response Structure

Returned value on success:

• HTTP status 200 (OK)
• A JSON string (content varies depending on which API is called)

Returned value on failure:

• HTTP status 500 (Internal Server Error), 400 (Bad Request), or 401 (Unauthorized)
• A JSON structure with the error details