PaloAltoNetworks / PaloAltoNetworks/pan.dev

Issue with "List all infrastructure settings"

Open
#256 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Documentation link

https://pan.dev/access/api/prisma-access-config/get-sse-config-v-1-shared-infrastructure-settings/

Describe the problem

Incorrect params described. Instructions advise no folder is required since the Infrastructure settings are always in the "Shared" area, but when you don't specify folder you get an error

{
	"_errors": [
		{
			"code": "API_I00035",
			"message": "Invalid Request Payload ",
			"details": [
				"\"folder\" is required"
			]
		}
	],
	"_request_id": "c78653ed-6a65-4536-aa6b-037094569d02"
}

Suggested fix

Either remove the folder requirement since it will always have to be shared or add instructions to include folder type and shared. Which requires this api call:

https://api.sase.paloaltonetworks.com/sse/config/v1/shared-infrastructure-settings?folder=Shared

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.

Research direction

Start with the linked pan.dev documentation page and compare its parameter instructions with the reported API request to /sse/config/v1/shared-infrastructure-settings. Update the documentation so the folder requirement and Shared value are accurate; it is done when the documented request matches the working API behavior.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.