Zero Touch RESTful API Overview

This API is a way to read information and send commands to the Zero TouchClosed Allows users to manage the initial configurations of "Small Office" and "Gaia Gateways" easily and remotely. Settings from the Zero Touch Server replace the First Time Configuration Wizard. The Zero Touch Cloud Service runs a Web Portal and supports REST API. All actions are available through API calls. server.

Operations that are available in the Zero Touch Cloud Service web portal (Check Point Zero Touch Portal) are available through web-services, with HTTPS Post requests to the Zero Touch Cloud Service.

Workflow for using the Zero Touch API commands:

  1. In the Zero Touch Web Portal, generate the pair of values - an API Client ID and an API Key.

    See the Zero Touch Administration Guide.

  2. Run the Zero Touch API command "login".

    See login.

    In the JSON payload, you must specify the pair - the API Client ID and the API Key.

    Syntax:

    {
"user": "YOUR_USERNAME",
"password": "YOUR_PASSWORD",
"api-client-id":"YOUR_API_CLIENT_ID",
"api-key":"YOUR_API_KEY"
}

  3. In the Zero Touch API response to the "login" command, get the value of the key "sid" - the session ID.

  4. In all subsequent Zero Touch API commands you run, in the JSON payload you must specify the key "X-chkp-sid" with the value that you received in the key "sid".

  5. At the end of you session, run the Zero Touch API command "logout".

    See logout.