What's New in R82 API

PhoneBoy — Fri, 13 Sep 2024 19:33:07 GMT

I was reading through the API documentation that was included with the R82 EA, which is available via https://mgmt-ip/api_docs
R82 will be API version 2.
Over 160 APIs were added and another 67 APIs were updated!
Here's the list (also includes new APIs from R81.20 JHF 43):

Application Ctrl & URL Filtering Advanced Settings (2)

API command	Description
set app-control-advanced-settings	Edit Application Control & URL Filtering Blades' Settings.
show app-control-advanced-settings	Show Application Control & URL Filtering Blades' Settings.

Content Awareness Advanced Settings (2)

API command	Description
set content-awareness-advanced-settings	Edit Content Awareness Blades' Settings.
show content-awareness-advanced-settings	Show Content Awareness Blades' Settings.

Data Type Compound Group (5)

API command	Description
add data-type-compound-group	Create new Compound Data Type Group Object.
delete data-type-compound-group	Delete existing Compound Data Type Group object using object name or uid.
set data-type-compound-group	Edit existing Compound Data Type Group object using object name or uid.
show data-type-compound-group	Retrieve existing Compound Data Type Group object using object name or uid.
show data-type-compound-groups	Retrieve all Compound Data Type Group objects.

Data Type File Attributes (5)

API command	Description
add data-type-file-attributes	Create new File Attributes Data Type Object.
delete data-type-file-attributes	Delete existing File Attributes Data Type object using object name or uid.
set data-type-file-attributes	Edit existing File Attributes Data Type object using object name or uid.
show data-type-file-attributes	Retrieve existing File Attributes Data Type object using object name or uid.
show data-types-file-attributes	Retrieve all File Attributes Data Type objects.

Data Type File Group (2)

API command	Description
show data-type-file-group	Retrieve existing File Group object using object name or uid.
show data-type-file-groups	Retrieve all File Group objects.

Data Type Group (5)

API command	Description
add data-type-group	Create new Data Group Type Object.
delete data-type-group	Delete existing Data Group Type object using object name or uid.
set data-type-group	Edit existing Data Group Type object using object name or uid.
show data-type-group	Retrieve existing Data Group Type object using object name or uid.
show data-type-groups	Retrieve all Data Group Type objects.

Data Type Keywords (5)

API command	Description
add data-type-keywords	Create new Keywords Data Type Object.
delete data-type-keywords	Delete existing Keywords Data Type object using object name or uid.
set data-type-keywords	Edit existing Keywords Data Type object using object name or uid.
show data-type-keywords	Retrieve existing Keywords Data Type object using object name or uid.
show data-types-keywords	Retrieve all Keywords Data Type objects.

Data Type Patterns (5)

API command	Description
add data-type-patterns	Create new Pattern Data Type Object.
delete data-type-patterns	Delete existing Pattern-Data-Type object using object name or uid.
set data-type-patterns	Edit existing Pattern Data Type object using object name or uid.
show data-type-patterns	Retrieve existing Pattern Data Type object using object name or uid.
show data-types-patterns	Retrieve all Pattern Data Type objects.

Data Type Traditional Group (5)

API command	Description
add data-type-traditional-group	Create new Traditional Group Data Type Object.
delete data-type-traditional-group	Delete existing Traditional Group Data Type using object name or uid.
set data-type-traditional-group	Edit existing Traditional Group Data Type using object name or uid.
show data-type-traditional-group	Retrieve existing Traditional Group Data Type using object name or uid.
show data-type-traditional-groups	Retrieve all Traditional Group Data Type objects.

Data Type Weighted-Keywords (5)

API command	Description
add data-type-weighted-keywords	Create new Weighted Keywords Data Type Object.
delete data-type-weighted-keywords	Delete existing Weighted Keywords Data Type object using object name or uid.
set data-type-weighted-keywords	Edit existing Weighted Keywords Data Type object using object name or uid.
show data-type-weighted-keywords	Retrieve existing Weighted Keywords Data Type object using object name or uid.
show data-types-weighted-keywords	Retrieve all Weighted Keywords Data Type objects.

Domain (1)

API command	Description
clone domain	Clones an existing Domain and applicable Check Point configuration. This command applies only to a Multi-Domain Security Management Server. This command is available only after you log in to the System Data domain.

External Trusted CA (5)

API command	Description
add external-trusted-ca	Create new object.
delete external-trusted-ca	Delete existing object using object name or uid.
set external-trusted-ca	Edit existing object using object name or uid.
show external-trusted-ca	Retrieve existing object using object name or uid.
show external-trusted-cas	Retrieve all objects.

Gateways & Clusters (1)

API command	Description
show gateway-capabilities	Show supported Check Point Gateway capabilities such as versions, hardware, platforms and blades.

Global Use (2)

API command	Description
set gateway-global-use	Enable or disable global usage on a specific target.
show gateway-global-use	Show global usage of a specific target.

High Availability (1)

API command	Description
show ha-status	Retrieve domain high availability status.

HTTPS Advanced Settings (2)

API command	Description
set https-advanced-settings	Configure advanced settings for HTTPS Inspection.
show https-advanced-settings	Show advanced settings for HTTPS Inspection.

Infinity Identity Providers (6)

API command	Description
delete infinity-idp	Delete Infinity Identity Provider from the Infinity Portal using object name or uid.
delete infinity-idp-object	Delete users/groups/machines from the Identity Provider using object name or uid.
show infinity-idp	Retrieve Infinity Identity Provider from the Infinity Portal using object name or uid.
show infinity-idp-object	Retrieve users/groups/machines from the Identity Provider using object name or uid.
show infinity-idp-objects	Retrieve all users/groups/machines from the Identity Provider.
show infinity-idps	Retrieve all Infinity Identity Provider from the Infinity Portal.

Internal Trusted CA (2)

API command	Description
set internal-trusted-ca	Edit existing Internal CA object.
show internal-trusted-ca	Retrieve existing Internal CA object.

Licenses (6)

API command	Description
add central-license	Add central license.
delete central-license	Delete central license.
distribute-cloud-licenses	Distribute licenses to target CloudGuard gateways. For more information, see the Central License Administration Guide.
show central-license	Show given license.
show central-licenses	Show attached licenses.
show cloud-licenses-usage	Show attached licenses usage.

Limit (6)

API command	Description
add limit	Create new Limit object.
clone limit	Clone an existing Limit object.
delete limit	Delete existing Limit object using object name or uid.
set limit	Edit existing Limit object using object name or uid.
show limit	Retrieve existing Limit object using object name or uid.
show limits	Retrieve all Limit objects.

Mobile Access Profile Rule (5)

API command	Description
add mobile-access-profile-rule	Create new Mobile Access Profile rule for associating groups of users with a profile configuration.
delete mobile-access-profile-rule	Delete existing Mobile Access Profile rule using rule number or uid or name.
set mobile-access-profile-rule	Edit existing Mobil Access Profile rule using rule number or uid or name.
show mobile-access-profile-rule	Retrieve existing Mobile Access Profile rule using rule number or uid or name.
show mobile-access-profile-rulebase	Shows the entire Mobile Access Profile Rules layer. This layer is divided into sections. A Mobile Profile Rule may be within a section, or independent of a section (in which case it is said to be under the "global" section). The reply features a list of objects. Each object may be a section of the layer, with all its rules in, or a rule itself, for the case of rules which are under the global section. An optional "filter" field may be added in order to filter out only those rules that match a search criteria.

Mobile Access Profile Section (4)

API command	Description
add mobile-access-profile-section	Create new Mobile Access Profile section.
delete mobile-access-profile-section	Delete existing Mobile Access Profile section using section name or uid.
set mobile-access-profile-section	Edit existing Mobile Access Profile section using section name or uid.
show mobile-access-profile-section	Retrieve existing Mobile Access Profile section using section name or uid.

Mobile Access Rule (5)

API command	Description
add mobile-access-rule	Create new Mobile Access rule for associating groups of users with a available apps.
delete mobile-access-rule	Delete existing Mobile Access rule using rule number or uid or name.
set mobile-access-rule	Edit existing Mobile Access rule using rule number or uid or name.
show mobile-access-rule	Retrieve existing Mobile Access rule using rule number or uid or name.
show mobile-access-rulebase	Shows the entire Mobile Access Rules layer. This layer is divided into sections. A Mobile Access Rule may be within a section, or independent of a section (in which case it is said to be under the "global" section). The reply features a list of objects. Each object may be a section of the layer, with all its rules in, or a rule itself, for the case of rules which are under the global section. An optional "filter" field may be added in order to filter out only those rules that match a search criteria.

Mobile Access Section (4)

API command	Description
add mobile-access-section	Create new Mobile Access section.
delete mobile-access-section	Delete existing Mobile Access section using section name or uid.
set mobile-access-section	Edit existing Mobile Access section using section name or uid.
show mobile-access-section	Retrieve existing Mobile Access section using section name or uid.

Mobile Profile (5)

API command	Description
add mobile-profile	Create new Mobile Profile.
delete mobile-profile	Delete existing Mobile Profile using name or uid.
set mobile-profile	Edit existing Mobile Profile using name or uid.
show mobile-profile	Retrieve existing Mobile Profile using name or uid.
show mobile-profiles	Retrieve all objects.

Multiple Key Exchanges (5)

API command	Description
add multiple-key-exchanges	Create new object.
delete multiple-key-exchanges	Delete existing object using object name or uid.
set multiple-key-exchanges	Edit existing object using object name or uid.
show multiple-key-exchanges	Retrieve existing object using object name or uid.
show multiple-key-exchanges-objects	Retrieve all objects.

Network Interface (5)

API command	Description
add interface	Add network interface.
delete interface	Delete existing network interface using object uid.
set interface	Edit existing network interface using object uid.
show interface	Retrieve existing network interface using object uid.
show interfaces	Retrieve all network interfaces for specified gateway or cluster.

Network Probe (6)

API command	Description
add network-probe	Create new object.
clone network-probe	Clone existing object.
delete network-probe	Delete existing object using object name or uid.
set network-probe	Edit existing object using object name or uid.
show network-probe	Retrieve existing object using object name or uid.
show network-probes	Retrieve all objects.

OPSEC Trusted CA (5)

API command	Description
add opsec-trusted-ca	Create new object.
delete opsec-trusted-ca	Delete existing object using object name or uid.
set opsec-trusted-ca	Edit existing object using object name or uid.
show opsec-trusted-ca	Retrieve existing object using object name or uid.
show opsec-trusted-cas	Retrieve all objects.

Outbound Inspection Certificate (2)

API command	Description
delete outbound-inspection-certificate	Delete existing object using object name or uid.
show outbound-inspection-certificates	Retrieve all objects.

Override Categorization (6)

API command	Description
add override-categorization	Create new object.
clone override-categorization	Clone existing object.
delete override-categorization	Delete existing object using object name or uid.
set override-categorization	Edit existing object using object name or uid.
show override-categorization	Retrieve existing object using object name or uid.
show override-categorizations	Retrieve all objects.

Passcode Profile (5)

API command	Description
add passcode-profile	Create new Passcode Profile for configurations Mobile Profile objects.
delete passcode-profile	Delete existing Passcode Profile using name or uid.
set passcode-profile	Edit existing Passcode Profile using name or uid.
show passcode-profile	Retrieve existing Passcode Profile using name or uid.
show passcode-profiles	Retrieve all objects.

Policy Package (1)

API command	Description
clone package	Clone existing policy package using policy name or uid.

Resource CIFS (6)

API command	Description
add resource-cifs	Create new object.
clone resource-cifs	Clone existing object.
delete resource-cifs	Delete existing object using object name or uid.
set resource-cifs	Edit existing object using object name or uid.
show resource-cifs	Retrieve existing object using object name or uid.
show resources-cifs	Retrieve all objects.

Resource FTP (6)

API command	Description
add resource-ftp	Create new object.
clone resource-ftp	Clone existing object.
delete resource-ftp	Delete existing object using object name or uid.
set resource-ftp	Edit existing object using object name or uid.
show resource-ftp	Retrieve existing object using object name or uid.
show resources-ftp	Retrieve all objects.

Resource SMTP (6)

API command	Description
add resource-smtp	Create new object.
clone resource-smtp	Clone existing object.
delete resource-smtp	Delete existing object using object name or uid.
set resource-smtp	Edit existing object using object name or uid.
show resource-smtp	Retrieve existing object using object name or uid.
show resources-smtp	Retrieve all objects.

Resource URI (6)

API command	Description
add resource-uri	Create new object.
clone resource-uri	Clone existing object.
delete resource-uri	Delete existing object using object name or uid.
set resource-uri	Edit existing object using object name or uid.
show resource-uri	Retrieve existing object using object name or uid.
show resources-uri	Retrieve all objects.

Trusted CA (1)

API command	Description
show trusted-cas	Retrieve all types of Trusted CA objects.

Trusted CA Certificate (11)

API command	Description
add custom-trusted-ca-certificate	Create new custom trusted CA certificate.
delete custom-trusted-ca-certificate	Delete existing custom trusted CA certificate using name or uid.
run-trusted-ca-update	Executes Trusted CAs package update.
set cp-trusted-ca-certificate	Edit existing Check Point trusted CA certificate using name or uid. By default all CP trusted CA certificates are enabled.
set trusted-ca-settings	Set trusted CAs package automatic update settings.
show cp-trusted-ca-certificate	Retrieve existing Check Point trusted CA certificate using name or uid.
show cp-trusted-ca-certificates	Retrieve all objects.
show custom-trusted-ca-certificate	Retrieve existing custom trusted CA certificate using name or uid.
show custom-trusted-ca-certificates	Retrieve all objects.
show trusted-ca-settings	Show trusted CAs package update settings.
show trusted-ca-status	Show Trusted CAs package status.

VSX (1)

API command	Description
vsx-provisioning-tool	Run the VSX provisioning tool with the specified parameters. Important note: An automatic session publish is part of all the operations in this API.

Re: What's New in R82 API

the_rock — Thu, 01 Aug 2024 23:49:19 GMT

Awesome...will check out some of those in the labs.

Andy

Re: What's New in R82 API

Don_Paterson — Fri, 13 Sep 2024 16:13:46 GMT

Hey Dameon,

Nice one. I came here looking for exactly this.

Was/is your R82 EA SMS using IP address 10.6.5.200?

The show more in the clone domain command gave it away.

Regards,

Don

Domain (1)

API command	Description
clone domain	Clones an existing Domain and applicable Check Point configuration. This command applies only to a Multi-D... show more

Re: What's New in R82 API

PhoneBoy — Fri, 13 Sep 2024 19:33:52 GMT

Yes, and I thought I had removed all of those instances 🙂

topic What's New in R82 API in API / CLI Discussion

What's New in R82 API

Application Ctrl & URL Filtering Advanced Settings (2)

Content Awareness Advanced Settings (2)

Data Type Compound Group (5)

Data Type File Attributes (5)

Data Type File Group (2)

Data Type Group (5)

Data Type Keywords (5)

Data Type Patterns (5)

Data Type Traditional Group (5)

Data Type Weighted-Keywords (5)

Domain (1)

External Trusted CA (5)

Gateways & Clusters (1)

Global Use (2)

High Availability (1)

HTTPS Advanced Settings (2)

Infinity Identity Providers (6)

Internal Trusted CA (2)

Licenses (6)

Limit (6)

Mobile Access Profile Rule (5)

Mobile Access Profile Section (4)

Mobile Access Rule (5)

Mobile Access Section (4)

Mobile Profile (5)

Multiple Key Exchanges (5)

Network Interface (5)

Network Probe (6)

OPSEC Trusted CA (5)

Outbound Inspection Certificate (2)

Override Categorization (6)

Passcode Profile (5)

Policy Package (1)

Resource CIFS (6)

Resource FTP (6)

Resource SMTP (6)

Resource URI (6)

Trusted CA (1)

Trusted CA Certificate (11)

VSX (1)

Re: What's New in R82 API

Re: What's New in R82 API

Domain (1)

Re: What's New in R82 API