PaloAltoNetworks / PaloAltoNetworks/pan.dev

Issue/Help with "Retrieve Incident Details by ID"

Open
#1,337 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/dlp/api/get-v-4-api-incidents-id/

Describe the problem

We are experiencing problems with SaaS API used in https://pan.dev/dlp/api/get-v-4-api-incidents-id/.

In the documentation it says that and array "data_patterns" is returned however when calling the API through the webpage and a script the response does not contain a data_pattern array.
The data pattern is available within the Data Loss Prevention incidents and SaaS Security incidents.

There is a mismatch between the documentation and what is happening with response from API.

Suggested fix

Ensure that the Data_pattern array is being returned.

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 documented endpoint at https://pan.dev/dlp/api/get-v-4-api-incidents-id/ and compare its documented data_patterns response with responses from the webpage and script. Confirm whether the mismatch is in the documentation or the SaaS API, then align the documented contract and returned response so the data_patterns array is consistently represented.

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
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.