pan.dev icon indicating copy to clipboard operation
pan.dev copied to clipboard

Issue/Help with "Create a security rule"

Open nmassman opened this issue 7 months ago • 2 comments

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.

nmassman avatar May 01 '25 14:05 nmassman

Hi @nmassman, thanks for reporting the issues - I believe I may have found some problems with how the position param and requestBody are getting parsed/rendered by the OpenAPI docs generator. Will try to get a fix in ASAP.

sserrata avatar May 01 '25 15:05 sserrata

Hi @nmassman, the fix is in - can you verify it addresses the issues you pointed out? Thanks!

sserrata avatar May 02 '25 16:05 sserrata