PaloAltoNetworks / PaloAltoNetworks/pan.dev
Issue/Help with "Update tunnel profiles"
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 78
- Forks
- 88
- Avg merge
- 5d 17h
- Merged PRs (30d)
- 18
Description
Documentation link
Tunnel Profiles API — Get Tunnel Profiles / Update Tunnel Profiles
GUI provides a Description field, but the API documentation does not mention it.
https://pan.dev/access/api/prisma-access-config/get-sse-config-v-1-mobile-agent-tunnel-profiles/
https://pan.dev/access/api/prisma-access-config/put-sse-config-v-1-mobile-agent-tunnel-profiles/
Describe the problem
In the Tunnel Profiles GUI, users can set a Description value for each profile.
However, the API behaves inconsistently with the GUI, and the documentation does not explain this discrepancy:
- The Get Tunnel Profiles API does not return the
descriptionfield, even when it is set in the GUI. - The Update Tunnel Profiles API does not allow updating the
descriptionfield. - When updating other profile settings through the API, the existing Description configured in the GUI is removed, because the API does not preserve it.
The documentation does not clarify whether this is intended behavior, a limitation, or an omission.
Suggested fix
- Please add support for the Description field in both the Get and Update Tunnel Profiles APIs, so that:
- The API can retrieve the Description set in the GUI.
- The API can update the Description value.
- Update the documentation to clearly describe:
- The expected behavior of the Description field.
- How the field should be handled when performing updates via API.
- If Description is currently unsupported by design, please document this explicitly and clarify why GUI and API behavior differ.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Get Tunnel Profiles and Update Tunnel Profiles API documentation and compare their schemas and update behavior with the GUI Description field described in the issue. Confirm whether the omission is intentional or a defect; done means the behavior is implemented or explicitly documented, including whether updates preserve Description.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100