Zero Touch API Commands

In This Section: login logout show-all-accounts

login

Description

Log in to the server with your Check Point User Center username (usually an email address) and password.

The server returns your session unique identifier. Enter this session unique identifier in the 'X-chkp-sid' header of each request.

Request URL

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

Request Headers

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

Request Body

Parameter Name	Value	Description
user Required	string	Check Point User Center username, usually an email address
password Required	string	Check Point User Center password

Response

On Success, HTTP Return code: 200

Parameter Name	Value	Description
last-login-was-at	object	Timestamps for last user login to the Zero Touch server

Parameter Name	Value	Description
url	string	URL that was used to reach the API server
sid	string	Session unique identifier for the 'X-chkp-sid' header of each request
user	string	Check Point User Center username, usually an email address

last-login-was-at

Parameter Name	Value	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	Value	Description
message	string	Operation status
messages	List: string	List of validation errors
code	string	Error code

Request

{

"user": "user@domain.com",

"password": "myUCpassword"

}

Response

{

"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@domain.com"

}

logout

Description

Log out from the current session. After logging out, the session ID is no longer valid.

Request URL

POST
https://zerotouch.checkpoint.com/ZeroTouch/web_api/v2/logout

Request Headers

Header Name	Value	Description
Content-Type	application /json	Send JSON object to use the API Web Services
X-chkp-sid	string token	Session unique identifier as the response to the login request

Request Body

There is no request body.

Response

On Success, HTTP Return code: 200

Parameter Name	Value	Description
message	string	Operation status
code	string	Message code

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

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

Response

{

"code": "17999",

"message": "Logout succeeded"

}

show-all-accounts

Description

Returns a list of the user's accounts in the Check Point User Center and in Zero Touch.

Request URL

POST
https://zerotouch.checkpoint.com/ZeroTouch/web_api/v2/show-all-accounts

Request Headers

Header Name	Value	Description
Content-Type	application /json	Send JSON object to use the API Web Services
X-chkp-sid	string token	Session unique identifier as the response to the login request

Request Body

There is no request body.

Response

On Success, HTTP Return code: 200
List of User's Check Point User Center accounts

Parameter Name	Value	Description
company-name	string	User's company name
account-name	string	Descriptive name within the user's company, usually
account-id	int	The User Center account to which gateways and templates belong
admin	boolean	If true, the user is an "Administrator" on the account with privileges If false, the user is a "Viewer" on the account with no privileges to make changes

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

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

Response

[

{

"company-name": "My Company",

"account-name": "My Account",

"account-id": 7852816,

"admin": false

},

{

"company-name": "My Company",

"account-name": "My Account2",

"account-id": 7899567,

"admin": true

}

]