PaloAltoNetworks / PaloAltoNetworks/pan.dev

Issue/Help with "Create a security rule"

Open
#891 2 comments 1 reaction 1 assignee View on GitHub

@sserrata is already working on this.

Since May 1, 2025.

documentation openapi-plugin
Dominant language
MDX
Stars
78
Forks
88
Avg merge
5d 17h
Merged PRs (30d)
18

Description

Documentation link

https://pan.dev/scm/api/config/ngfw/security/create-security-rules/
and all other documentation pages relating to creation and updating of various rule types, both for NGFW and SASE.

Describe the problem

The documentation for how to create rules in all of the various rule bases via the SCM API is woefully inadequate. Absolutely no details are provided on the acceptable structure of the rule parameters themselves. Additionally, some but not all of the create rule documents list a "position" parameter, with no explanation of how this parameter works or what values it accepts. There also is no documentation of what the response should include for rule creation API calls. It just says "Created".

Suggested fix

SCM API documentation needs to be dramatically expanded on.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.