RESTful API
Quantum Spark 1500, 1600 and 1800 Appliance Series R80.20.40 Locally Managed Administration Guide | 297
REST API Commands
(1) Login
Description
1. Log in to the SMB appliance with your SMB admin username and password.
2. The SMB returns your session unique identifier.
3. Enter this session unique identifier in the
x-chkp-sid
header of each request.
Request URL
POST https://<gateway-ip>:<port>/web-api/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
Administrator username
Password
(Required)
String
Administrator password
Response
On Success, HTTP Return code: 200
Header Name
Value
Description
sid
String
Session unique identifier for the
x-chkp-sid
header of each
request.
role
String
The administrator role and permissions.
read-only
Boolean
True if the session is read only.
api-server-
version
String
API server version.
session-timeout
Integer
Session expiration timeout in minutes.
On Failure, HTTP Return code: 400, 401, 500