login

Description

Log in to the Zero Touch 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. service with your API Client ID and API Key - see the Zero Touch Administration Guide > Section "Managing API Keys".

The service returns your session unique identifier.

Use this session unique identifier as the value of the "X-chkp-sid" key in each Zero Touch API request.

Request URL

POST

https://zerotouch.checkpoint.com/ZeroTouch/web_api/v2/login

Request Headers

Parameter Name	Type	Description
`Content-Type`	application/json	Send JSON object to use the API Web Services

Request Body

Parameter Name	Status	Type	Description
`api-client-id`	Mandatory	string	API Client ID you generated in the Zero Touch Web Portal
`api-key`	Mandatory	string	API Key you generated in the Zero Touch Web Portal

Response

On Success, HTTP Return code: 200

Parameter Name	Type	Description
`url`	string	URL that was used to reach the Zero Touch API service
`last-login-was-at`	object	Timestamps for last user login to the Zero Touch API service
`sid`	string	Session unique identifier you must as the value of the "`X-chkp-sid`" key in each API request (except "`login`")
`user`	string	Check Point User Center email address

last-login-was-at

Parameter Name	Type	Description
`posix`	int	The value is the number of milliseconds that have elapsed since 00:00:00, 1 January 1970
`iso-8601`	string	Date and time represented in international ISO 8601 format

On Failure, HTTP Return code: 400, 401, 500

Parameter Name	Type	Description
`message`	string	Operation status
`messages`	List: string	List of validation errors
`code`	string	Error code

Request Example

{
"api-client-id":"ilA0GlJvwjkdjQiA",
"api-key":"WC9wvDzVTXS2afc8eCyZ4rG_LtSL5gPhXhkD0XtyZYg"
}

Response Example

{
"url": "https://zerotouch.checkpoint.com/ZeroTouch/web_api/v2",
"last-login-was-at": {
  "posix": 1530099088,
  "iso-8601": "2018-06-27T11:31"
},
"sid": "S4IaC3Js_kU4TL1x2_QF0uYQXlgQt82hq5vh2ytNKAc",
"user": "user@example.com"
}