topic Re: Using the API to get unused and used rules in Automation/API Discussions

Using the API to get unused and used rules

StefanV — Fri, 11 Jul 2014 13:55:42 GMT

Hi all,

I am trying to use the API to get a list of unused and another of used rules. Via the API I only get the following error

<response status="error"><msg><line>An error occured. See dagger.log for information.</line></msg></response>

I have also tried with the following

https://hostname/api/?type=op&action=show&key=PaloaltoKey&xpath=/show/running/rule-use/rule-base=security/type=used/vsys…

I then get a list of all policies. This does not change even if I change from used to unused, or from security to nat or pbf.

Does anyone know how to get an api command that will simply list the unused security rules as on e would get from a normal command line query?

Hope so,

thanks

Stefan

Re: Using the API to get unused and used rules

pulukas — Fri, 11 Jul 2014 21:25:36 GMT

Have you seen the option on the GUI?

Policy tab and on the bottom of the screen is the check box to highlight unused policies.

Re: Using the API to get unused and used rules

ajbool — Sun, 13 Jul 2014 15:00:00 GMT

You need send the following over the API,

<show><running><rule-use><vsys>vsys1</vsys><type>unused</type><rule-base>security</rule-base></rule-use></running></show>

The resultant URL would look look like this,

https://MYFIREWALL/api/?cmd=%3Cshow%3E%3Crunning%3E%3Crule-use%3E%3Cvsys%3Evsys1%3C%2Fvsys%3E%3Ctype%3Eunused%3C%2Ftype%3E%3Crule-base%3Esecurity%3C%2Frule-base%3E%3C%2Frule-use%3E%3C%2Frunning%3E%3C%2Fshow%3E&type=op&key=MYKEY

Re: Using the API to get unused and used rules

kadak — Wed, 16 Jul 2014 17:51:18 GMT

Hello StefanV

Please try this one:

https://192.168.50.10/api/?REST_API_TOKEN=1239250485&type=op&cmd=<show><running><rule-use><vsys>vsys1</vsys><rule-base>security</rule-base><type>unused</type></rule-use></running></show>

Hope that helps!

Thanks and regards,

Kunal Adak

Re: Using the API to get unused and used rules

StefanV — Wed, 16 Jul 2014 23:32:02 GMT

Thanks everyone for the responses. All of them works

Re: Using the API to get unused and used rules

jasonrakers — Tue, 09 Apr 2019 18:41:23 GMT

I wanted to provide an example if using Panorama.

This is a snippet from Postman where i have variables for Panorama and the associated api key {{prod-panorama}} and whatever device-group I want to review {{device-group}}. To retrieve pre-rules with no hits:

Re: Using the API to get unused and used rules

Serhan — Mon, 12 Apr 2021 07:38:24 GMT

Hi thank you for sharing the API for using panorama, one more question if i may

Do you know if there is any API using Panorama that i can get all used rules with timestamp of last used.

from the API above i can get only the timestamp of last modify and timestamp of creation.

@jasonrakers your help will be much appreciated

Re: Using the API to get unused and used rules

JimmyHolland — Wed, 12 May 2021 16:17:35 GMT

Hi @Serhan,

At Panorama level, this command will get stats for all rules at summary level:

https://{{host}}/api?key={{key}}&type=op&cmd=<show><rule-hit-count><device-group><entry name='{{device-group-name}}'><pre-rulebase><entry name='security'><rules><all/></rules></entry></pre-rulebase></entry></device-group></rule-hit-count></show>

If you use a similar command for a specific rule, you can detailed stats including last-hit-timestamp:

https://{{host}}/api?key={{key}}&type=op&cmd=<show><rule-hit-count><device-group><entry name='{{device-group-name}}'><pre-rulebase><entry name='security'><rules><rule-name><entry name='{{rule-name}}'/></rule-name></rules></entry></pre-rulebase></entry></device-group></rule-hit-count></show>

Hope that helps.