Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Check Point Software Session API

The Session API from Check Point Software — 3 operation(s) for session.

Check Point Software Session API is one of 8 APIs that Check Point Software publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Session. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version latest.

Requests are made against a single base URL, https://{management_server}/web_api.

3 operations 3 paths 3 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
latest
Base URL
https://{management_server}/web_api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Check Point Software Session API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-chkp-sid (sessionId). By default, every request must be authenticated.

  • sessionId — Session ID returned by /login, supplied on every subsequent call.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Session 3
POST
/login
Login and obtain a session ID (sid)
login body → 200
POST
/logout
Logout and invalidate the session ID
logout body → 200
POST
/publish
Publish staged changes
publish body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are LoginResponse (6 properties), GenericMessage (1 property), TaskResponse (1 property). Each schema is shown below with its type and property counts.

LoginResponse
object
6 properties
TaskResponse
object
1 property
GenericMessage
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

check-point-session-api-openapi.yml Raw ↑

Other APIs Check Point Software publishes across the network.

Check Point Management API
Check Point GAIA API
Check Point Spark Management API
Check Point Software Access Rules API
Check Point Software Gateways API
Check Point Software Hosts API
Check Point Software Networks API