Add address group members
Action ID:tools.pan_os.add_address_group_members
Add members of a static address group in the candidate configuration. Reads the group with GET /restapi/{version}/Objects/AddressGroups?name= and writes it with PUT only when membership changes, so repeated calls are idempotent. Commit to apply the change.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/work-with-address-objects-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Block CIDR
Action ID:tools.pan_os.block_cidr
Block a CIDR range by adding an address object to a static address group referenced by a deny rule. Looks up the address object by name, creates it with POST /restapi/{version}/Objects/Addresses if missing, then adds it to the group with PUT /restapi/{version}/Objects/AddressGroups if it is not already a member, so repeated calls do not create duplicates. Changes stay in the candidate configuration; run commit (and commit_all on Panorama) to enforce them. For temporary blocks without a commit, use register_ip_tags with a dynamic address group.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/work-with-address-objects-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Block FQDN
Action ID:tools.pan_os.block_fqdn
Block an FQDN by adding an address object to a static address group referenced by a deny rule. Looks up the address object by name, creates it with POST /restapi/{version}/Objects/Addresses if missing, then adds it to the group with PUT /restapi/{version}/Objects/AddressGroups if it is not already a member, so repeated calls do not create duplicates. Changes stay in the candidate configuration; run commit (and commit_all on Panorama) to enforce them. For temporary blocks without a commit, use register_ip_tags with a dynamic address group.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/work-with-address-objects-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Block IP
Action ID:tools.pan_os.block_ip
Block an IP address by adding an address object to a static address group referenced by a deny rule. Looks up the address object by name, creates it with POST /restapi/{version}/Objects/Addresses if missing, then adds it to the group with PUT /restapi/{version}/Objects/AddressGroups if it is not already a member, so repeated calls do not create duplicates. Changes stay in the candidate configuration; run commit (and commit_all on Panorama) to enforce them. For temporary blocks without a commit, use register_ip_tags with a dynamic address group.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/work-with-address-objects-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Commit
Action ID:tools.pan_os.commit
Commit the candidate configuration on a firewall or Panorama with the XML API (type=commit). Optionally commit only changes made by specific administrators. Returns the job ID, or no job ID when there is nothing to commit; use wait_for_job to wait for completion.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/pan-os-xml-api-request-types/commit-configuration-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Commit only changes made by these administrators (partial commit).Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Create address
Action ID:tools.pan_os.create_address
Create an address object in the candidate configuration with POST /restapi/{version}/Objects/Addresses?name=. Provide exactly one of ip_netmask, ip_range, ip_wildcard, or fqdn. Commit to apply the change.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/work-with-address-objects-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Create address group
Action ID:tools.pan_os.create_address_group
Create a static or dynamic address group in the candidate configuration with POST /restapi/{version}/Objects/AddressGroups?name=. Provide exactly one of static_members or dynamic_filter. Commit to apply the change.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/work-with-address-objects-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Create security rule
Action ID:tools.pan_os.create_security_rule
Create a security rule in the candidate configuration with POST /restapi/{version}/Policies/SecurityRules?name= (SecurityPreRules or SecurityPostRules on Panorama). The rule is added at the bottom; use move_security_rule to place it. Commit to apply the change.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/create-security-policy-rule-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Action to take when the rule matches. Allowed values: allow, deny, drop, reset-client, reset-server, reset-both.
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Rulebase. Use security on firewalls; pre or post on Panorama, with location shared or device-group. Allowed values: security, pre, post.Default:
"security".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Create tag
Action ID:tools.pan_os.create_tag
Create a tag in the candidate configuration with POST /restapi/{version}/Objects/Tags?name=. Commit to apply the change.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/create-a-tag-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Delete address
Action ID:tools.pan_os.delete_address
Delete a address object from the candidate configuration with DELETE /restapi/{version}/Objects/Addresses?name=. Commit to apply the change.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/work-with-address-objects-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Delete address group
Action ID:tools.pan_os.delete_address_group
Delete a address group from the candidate configuration with DELETE /restapi/{version}/Objects/AddressGroups?name=. Commit to apply the change.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/work-with-address-objects-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Delete security rule
Action ID:tools.pan_os.delete_security_rule
Delete a security rule from the candidate configuration with DELETE /restapi/{version}/Policies/${{ “SecurityPreRules” if inputs.rulebase == “pre” else (“SecurityPostRules” if inputs.rulebase == “post” else “SecurityRules”) }}?name=. Commit to apply the change.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/create-security-policy-rule-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Rulebase. Use security on firewalls; pre or post on Panorama, with location shared or device-group. Allowed values: security, pre, post.Default:
"security".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Disable security rule
Action ID:tools.pan_os.disable_security_rule
Disable a security rule in the candidate configuration. Reads it with GET /restapi/{version}/Policies/SecurityRules?name= and writes it with PUT only when the state changes, so repeated calls are idempotent. Commit to apply the change.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/create-security-policy-rule-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Rulebase. Use security on firewalls; pre or post on Panorama, with location shared or device-group. Allowed values: security, pre, post.Default:
"security".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Enable security rule
Action ID:tools.pan_os.enable_security_rule
Enable a security rule in the candidate configuration. Reads it with GET /restapi/{version}/Policies/SecurityRules?name= and writes it with PUT only when the state changes, so repeated calls are idempotent. Commit to apply the change.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/create-security-policy-rule-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Rulebase. Use security on firewalls; pre or post on Panorama, with location shared or device-group. Allowed values: security, pre, post.Default:
"security".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Get address
Action ID:tools.pan_os.get_address
Get a address object by name with GET /restapi/{version}/Objects/Addresses?name=.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/work-with-address-objects-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Get address group
Action ID:tools.pan_os.get_address_group
Get a address group by name with GET /restapi/{version}/Objects/AddressGroups?name=.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/work-with-address-objects-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Get job
Action ID:tools.pan_os.get_job
Get a job (commit, push, content install) with the XML API operational command show jobs id. Returns normalized status, result, done, and succeeded fields.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/pan-os-xml-api-request-types/run-operational-mode-commands-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Get security rule
Action ID:tools.pan_os.get_security_rule
Get a security rule by name with GET /restapi/{version}/Policies/${{ “SecurityPreRules” if inputs.rulebase == “pre” else (“SecurityPostRules” if inputs.rulebase == “post” else “SecurityRules”) }}?name=.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/create-security-policy-rule-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Rulebase. Use security on firewalls; pre or post on Panorama, with location shared or device-group. Allowed values: security, pre, post.Default:
"security".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Get system info
Action ID:tools.pan_os.get_system_info
Get hostname, model, serial, PAN-OS version, and content versions with the XML API operational command show system info.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/pan-os-xml-api-request-types/run-operational-mode-commands-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.List address groups
Action ID:tools.pan_os.list_address_groups
List address groups with GET /restapi/{version}/Objects/AddressGroups.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/work-with-address-objects-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.List addresses
Action ID:tools.pan_os.list_addresses
List address objects with GET /restapi/{version}/Objects/Addresses.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/work-with-address-objects-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.List device groups
Action ID:tools.pan_os.list_device_groups
List Panorama device groups and their member firewalls with the XML API operational command show devicegroups. Use the names as device_group with location device-group in object and security rule actions, and with commit_all.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/pan-os-xml-api-request-types/run-operational-mode-commands-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.List external dynamic lists
Action ID:tools.pan_os.list_external_dynamic_lists
List external dynamic lists with GET /restapi/{version}/Objects/ExternalDynamicLists.
Reference: https://pan.dev/panos/docs/restapi/
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.List managed firewalls
Action ID:tools.pan_os.list_managed_devices
List firewalls managed by Panorama with the XML API operational command show devices all (or show devices connected). Returns serial, hostname, management IP, model, PAN-OS version, connection state, and the remaining API-native fields for each firewall.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/pan-os-xml-api-request-types/run-operational-mode-commands-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.List registered IPs
Action ID:tools.pan_os.list_registered_ips
List IP addresses registered with tags for dynamic address groups with the XML API operational command show object registered-ip, optionally filtered by IP or tag.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/pan-os-xml-api-request-types/run-operational-mode-commands-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.List security rules
Action ID:tools.pan_os.list_security_rules
List security rules with GET /restapi/{version}/Policies/${{ “SecurityPreRules” if inputs.rulebase == “pre” else (“SecurityPostRules” if inputs.rulebase == “post” else “SecurityRules”) }}.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/create-security-policy-rule-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Rulebase. Use security on firewalls; pre or post on Panorama, with location shared or device-group. Allowed values: security, pre, post.Default:
"security".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.List tags
Action ID:tools.pan_os.list_tags
List tags with GET /restapi/{version}/Objects/Tags.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/create-a-tag-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.List template stacks
Action ID:tools.pan_os.list_template_stacks
List Panorama template stacks with the XML API (type=config, action=get) for /config/devices/entry[@name=‘localhost.localdomain’]/template-stack. Returns each name, description, member templates (stacks only), and assigned firewall serial numbers.
Reference: https://docs.paloaltonetworks.com/ngfw/api/pan-os-xml-api-request-types-and-actions/configuration-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.List templates
Action ID:tools.pan_os.list_templates
List Panorama templates with the XML API (type=config, action=get) for /config/devices/entry[@name=‘localhost.localdomain’]/template. Returns each name, description, member templates (stacks only), and assigned firewall serial numbers.
Reference: https://docs.paloaltonetworks.com/ngfw/api/pan-os-xml-api-request-types-and-actions/configuration-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Move security rule
Action ID:tools.pan_os.move_security_rule
Move a security rule with POST /restapi/{version}/Policies/SecurityRules:move?where=&dst= (SecurityPreRules or SecurityPostRules on Panorama). Commit to apply the change.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/create-security-policy-rule-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Rulebase. Use security on firewalls; pre or post on Panorama, with location shared or device-group. Allowed values: security, pre, post.Default:
"security".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Push template
Action ID:tools.pan_os.push_template
Push template configuration from Panorama to its firewalls with the XML API (type=commit, action=all, commit-all template). Optionally limit the push to specific firewall serial numbers. Commit on Panorama first. Returns the job ID; use wait_for_job to wait for completion.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/pan-os-xml-api-request-types/commit-configuration-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Push template stack
Action ID:tools.pan_os.push_template_stack
Push template stack configuration from Panorama to its firewalls with the XML API (type=commit, action=all, commit-all template-stack). Optionally limit the push to specific firewall serial numbers. Commit on Panorama first. Returns the job ID; use wait_for_job to wait for completion.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/pan-os-xml-api-request-types/commit-configuration-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Push to device groups (Panorama)
Action ID:tools.pan_os.commit_all
Push committed Panorama configuration to the firewalls in one or more device groups with the XML API (type=commit, action=all, commit-all shared-policy). Optionally limit the push to specific firewall serial numbers. Commit on Panorama first. Returns the job ID; use wait_for_job to wait for completion.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/pan-os-xml-api-request-types/commit-configuration-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Limit the push to these firewall serial numbers in each device group.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Query logs
Action ID:tools.pan_os.query_logs
Search firewall or Panorama logs with the XML API log retrieval (type=log). Submits the query, polls the log job until it finishes, and returns the log entries.
Reference: https://pan.dev/panos/docs/xmlapi/
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Log type to search. Allowed values: traffic, threat, url, wildfire, data, auth, decryption, userid, gtp, tunnel, sctp, system, config, hipmatch, globalprotect.
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Refresh external dynamic list
Action ID:tools.pan_os.refresh_external_dynamic_list
Refresh an external dynamic list now instead of waiting for its schedule, with the XML API operational command request system external-list refresh. Use after updating an EDL feed with new indicators.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/pan-os-xml-api-request-types/run-operational-mode-commands-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Register IP tags
Action ID:tools.pan_os.register_ip_tags
Tag IP addresses with the User-ID XML API (type=user-id, uid-message register) so dynamic address groups that match the tags pick them up without a commit. Set timeout for temporary containment; PAN-OS removes the tag when it expires.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/pan-os-xml-api-request-types/apply-user-id-mapping-and-populate-dynamic-address-groups-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Seconds until the tag expires (PAN-OS 9.0 or later). Omit for no expiry.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Remove address group members
Action ID:tools.pan_os.remove_address_group_members
Remove members of a static address group in the candidate configuration. Reads the group with GET /restapi/{version}/Objects/AddressGroups?name= and writes it with PUT only when membership changes, so repeated calls are idempotent. Commit to apply the change.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/work-with-address-objects-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Run operational command
Action ID:tools.pan_os.run_op_command
Run an operational command with the XML API (type=op) and return the parsed response, e.g. <show><session><all><filter><source>203.0.113.10</source></filter></all></session></show>.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/pan-os-xml-api-request-types/run-operational-mode-commands-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Test security policy match
Action ID:tools.pan_os.test_security_policy_match
Find the security rule that matches a traffic tuple with the XML API operational command test security-policy-match. Use it to confirm a block is effective or to explain why traffic was allowed.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/pan-os-xml-api-request-types/run-operational-mode-commands-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Unblock FQDN
Action ID:tools.pan_os.unblock_fqdn
Unblock an FQDN blocked with the matching block action. Removes the address object from the static address group with PUT /restapi/{version}/Objects/AddressGroups if it is a member, then deletes the address object with DELETE /restapi/{version}/Objects/Addresses if it exists. Repeated calls are no-ops. Changes stay in the candidate configuration; run commit (and commit_all on Panorama) to enforce them.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/work-with-address-objects-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Delete the address object after removing it from the group. Fails if other rules or groups still reference it.Default:
true.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Unblock IP
Action ID:tools.pan_os.unblock_ip
Unblock an IP address or CIDR range blocked with the matching block action. Removes the address object from the static address group with PUT /restapi/{version}/Objects/AddressGroups if it is a member, then deletes the address object with DELETE /restapi/{version}/Objects/Addresses if it exists. Repeated calls are no-ops. Changes stay in the candidate configuration; run commit (and commit_all on Panorama) to enforce them.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/work-with-address-objects-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Delete the address object after removing it from the group. Fails if other rules or groups still reference it.Default:
true.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Unregister IP tags
Action ID:tools.pan_os.unregister_ip_tags
Remove tags from IP addresses with the User-ID XML API (type=user-id, uid-message unregister), which removes them from dynamic address groups that match the tags.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/pan-os-xml-api-request-types/apply-user-id-mapping-and-populate-dynamic-address-groups-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Update address
Action ID:tools.pan_os.update_address
Update a address object in the candidate configuration. Reads it with GET /restapi/{version}/Objects/Addresses?name=, applies only the provided fields, and writes it with PUT. Commit to apply the change.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/work-with-address-objects-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Update security rule
Action ID:tools.pan_os.update_security_rule
Update a security rule in the candidate configuration. Reads it with GET /restapi/{version}/Policies/${{ “SecurityPreRules” if inputs.rulebase == “pre” else (“SecurityPostRules” if inputs.rulebase == “post” else “SecurityRules”) }}?name=, applies only the provided fields, and writes it with PUT. Commit to apply the change.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/get-started-with-the-pan-os-rest-api/create-security-policy-rule-rest-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
API-native entry fields to replace, e.g. {“action”: “deny”, “source”: {“member”: [“blocked-ips”]}}.
PAN-OS REST API version, e.g. v11.1 or v10.2. Falls back to the workspace variable pan_os.api_version, then v11.1.Default:
null.Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.Configuration location. Use vsys on firewalls, device-group or shared on Panorama. Allowed values: vsys, shared, device-group.Default:
"vsys".Rulebase. Use security on firewalls; pre or post on Panorama, with location shared or device-group. Allowed values: security, pre, post.Default:
"security".Verify the management TLS certificate. Prefer adding a CA_CERTIFICATE secret over disabling this.Default:
true.Wait for job
Action ID:tools.pan_os.wait_for_job
Poll a job with the XML API operational command show jobs id until it finishes, then return normalized status, result, done, and succeeded fields. Fails when the job fails, unless raise_on_failure is false, or when it does not finish within poll_max_attempts.
Reference: https://docs.paloaltonetworks.com/pan-os/11-1/pan-os-panorama-api/pan-os-xml-api-request-types/run-operational-mode-commands-api
Secrets
Required secrets:pan_os: required valuesPANOS_API_KEY.
Input fields
Firewall or Panorama management URL, e.g. https://fw.example.com. Falls back to the workspace variable pan_os.base_url.Default:
null.