R80.40 API v1.6 Changelog

[JozkoMrkvicka]

Changelog

What's New in v1.6

 This release, API version 1.6, introduces several updates for existing APIs.
 Deprecated API commands from this version:

• show data-center command is deprecated, use show data-center-server instead.
• show data-centers command is deprecated, use show data-center-servers instead.

 New APIs (35)

 API Key (2)

API command	Description
add api-key	Add API key for administrator, to enable login with it. For the key to be valid publish is needed.When using mgmt_cli tool, add –f json to get the key in the command’s output
delete api-key	Delete the API key. For the key to be invalid publish is needed.

Data Center Server (4)

API command	Description
delete data-center-server	Delete existing Data Center Server using name or uid.
set data-center-server	Edit existing Data Center Server using name or uid. Data Center Server represents the connection to a cloud environment. The Data Center Server contains Data Center Objects, these objects can be imported from it using the add-data-center-object command
show data-center-server	Retrieve existing Data Center Server using name or uid.
show data-center-servers	Retrieve existing Data Center Servers.

LSV Profile (5)

API command	Description
add lsv-profile	Add a new Large Scale VPN object. When used inside a VPN Community, the object enables communication between a large amount of externally managed VPN peers.
delete lsv-profile	Delete existing LSV profile object using object name or uid.
set lsv-profile	Set LSV Profile object's fields. Set CA by uid or name, change peers limit or restrict encryption domain.
show lsv-profile	Retrieve existing LSV profile object using object name or uid.
show lsv-profiles	Retrieve all objects.

Migration (4)

API command	Description
backup-domain	Back up the Domain database and applicable Check Point configuration. This command can be used in backup and restore operations. This command is available only in a Multi-Domain environment and when logged into the MDS domain. For known limitations see sk146953
migrate-export-domain	Export the Domain database and applicable Check Point configuration. This command can be used in export and import operations. This command is available only when logged into the system domain. For known limitations see sk156072
migrate-import-domain	Imports the exported Domain database and applicable Check Point configuration. This command can be used in import operations. This command is available only when logged into the system domain. For known limitations see sk156072
restore-domain	Restores the backed-up Domain database and applicable Check Point configuration. This command can be used in restore operations. This command is available only in a Multi-Domain environment and when logged into the MDS domain. For known limitations see sk146953

 

Misc. (1)

API command	Description
install-database	Copies the user database and network objects information to specified targets.

 

Server Certificate (5)

API command	Description
add server-certificate	Import server certificates for inbound HTTPS traffic inspection.You can use the imported server certificates in the Certificate column of the HTTPS Inspection Policy.
delete server-certificate	Delete existing server certificate using name or uid.
set server-certificate	Edit existing server certificate using name or uid.
show server-certificate	Show existing server certificate using name or uid.
show server-certificates	Show existing server certificates.

Session Management (2)

API command	Description
revert-to-revision	Revert the Management Database to the selected revision.
verify-revert	Verify the Management Database can revert to the selected revision.

Simple Cluster (5)

API command	Description
add simple-cluster	Create new object.
delete simple-cluster	Delete existing object using object name or uid.
set simple-cluster	Edit existing object using object name or uid.
show simple-cluster	Retrieve existing object using object name or uid.
show simple-clusters	Retrieve all objects.

SmartTasks (5)

API command	Description
add smart-task	Create new object.
delete smart-task	Delete existing object using object name or uid.
set smart-task	Edit existing object using object name or uid.
show smart-task	Retrieve existing object using object name or uid.
show smart-tasks	Retrieve all objects.

Triggers (2)

API command	Description
show smart-task-trigger	Retrieve existing object using object name or uid.
show smart-task-triggers	Retrieve all objects.

 

Updated APIs (10)

Threat Profile (3)

API command	Added fields	Removed fields	Updated fields	Description
set threat-profile	1	0	0	Edit existing object using object name or uid.
show threat-profile	2	0	0	Retrieve existing object using object name or uid.
add threat-profile	1	0	0	Create new object.

Threat Protection (1)

API command	Added fields	Removed fields	Updated fields	Description
show threat-protections	1	0	0	Retrieve all objects.

VPN Community Meshed (3)

API command	Added fields	Removed fields	Updated fields	Description
show vpn-community-meshed	1	0	0	Retrieve existing object using object name or uid.
set vpn-community-meshed	2	0	0	Edit existing object using object name or uid.
add vpn-community-meshed	2	0	0	Create new object.

VPN Community Star (3)

API command	Added fields	Removed fields	Updated fields	Description
set vpn-community-star	2	0	0	Edit existing object using object name or uid.
show vpn-community-star	1	0	0	Retrieve existing object using object name or uid.
add vpn-community-star	2	0	0	Create new object.

 

Deprecated APIs (2)

Data Center Server (2)

API command	Description
show data-center	Retrieve existing Data Center Server using name or uid. Starting from version 1.6 of the Check Point Management API, this command is deprecated . Use the show data-center-server command instead
show data-centers	Retrieve existing Data Center Servers. Starting from version 1.6 of the Check Point Management API, this command is deprecated . Use the show data-center-servers command instead