PaloAltoNetworks / PaloAltoNetworks/pan.dev
No documentation of Alarms API endpoint
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 78
- Forks
- 88
- Avg merge
- 5d 17h
- Merged PRs (30d)
- 18
Description
Documentation link
https://pan.dev/prisma-cloud/api/
Describe the problem
The /alarms endpoint is not documented but is very useful to customers - the Alarm Center is lacking in features so I am using the Alarms API to surface alarms and then, because the notifications from Alarm Center (to email) do not contain remediation information and instead direct you to login to the console to check, I use the /account/{account id}/config/status endpoint to retrieve the remediation information for the required account e.g.
GET https://{{myenv}}/account/a12b34cd3-567e-8fed-cb76-1234567a1a2a/config/status
[
{
"name": "Config",
"status": "warning",
"message": "Prisma Cloud application is not assigned following action(s): [\"Microsoft.ContainerRegistry/registries/webhooks/getCallbackConfig/action\"]\n",
"remediation": "Assign the mentioned action(s) to Prisma Cloud application: [\"Microsoft.ContainerRegistry/registries/webhooks/getCallbackConfig/action\"]\n",
"subComponents": []
},
{
"name": "Audit Logs",
"status": "ok",
"message": "",
"remediation": "",
"subComponents": []
},
{
"name": "Flow logs",
"status": "ok",
"message": "",
"remediation": "",
"subComponents": []
},
{
"name": "Authentication",
"status": "ok",
"message": "",
"remediation": "",
"subComponents": []
},
{
"name": "Compute Discovery",
"status": "warning",
"message": "Prisma Cloud application is not assigned following action(s): [\"Microsoft.ContainerInstance/containerGroups/containers/exec/action\"]\n",
"remediation": "Assign the mentioned action(s) to Prisma Cloud application: [\"Microsoft.ContainerInstance/containerGroups/containers/exec/action\"]\n",
"subComponents": []
},
{
"name": "Remediation",
"status": "warning",
"message": "Prisma Cloud application is not assigned following action(s): [\"Microsoft.Web/sites/config/Write\", \"Microsoft.Sql/servers/databases/transparentDataEncryption/write\", \"Microsoft.DBforMySQL/flexibleServers/configurations/write\", \"Microsoft.Sql/servers/databases/securityAlertPolicies/write\", \"Microsoft.Web/sites/Write\", \"Microsoft.Security/autoProvisioningSettings/write\", \"Microsoft.Storage/storageAccounts/write\", \"Microsoft.DBforPostgreSQL/servers/configurations/write\", \"Microsoft.Insights/LogProfiles/Delete\", \"Microsoft.Authorization/policyAssignments/write\", \"Microsoft.Authorization/policyAssignments/delete\", \"Microsoft.Storage/storageAccounts/*\", \"Microsoft.Insights/LogProfiles/Write\"]\n",
"remediation": "Assign the mentioned action(s) to Prisma Cloud application: [\"Microsoft.Web/sites/config/Write\", \"Microsoft.Sql/servers/databases/transparentDataEncryption/write\", \"Microsoft.DBforMySQL/flexibleServers/configurations/write\", \"Microsoft.Sql/servers/databases/securityAlertPolicies/write\", \"Microsoft.Web/sites/Write\", \"Microsoft.Security/autoProvisioningSettings/write\", \"Microsoft.Storage/storageAccounts/write\", \"Microsoft.DBforPostgreSQL/servers/configurations/write\", \"Microsoft.Insights/LogProfiles/Delete\", \"Microsoft.Authorization/policyAssignments/write\", \"Microsoft.Authorization/policyAssignments/delete\", \"Microsoft.Storage/storageAccounts/*\", \"Microsoft.Insights/LogProfiles/Write\"]\n",
"subComponents": []
},
{
"name": "Serverless Function Scanning",
"status": "warning",
"message": "Prisma Cloud application is not assigned following action(s): [\"Microsoft.web/sites/functions/action\", \"Microsoft.Web/sites/publishxml/action\", \"Microsoft.Web/sites/config/list/action\"]\n",
"remediation": "Assign the mentioned action(s) to Prisma Cloud application: [\"Microsoft.web/sites/functions/action\", \"Microsoft.Web/sites/publishxml/action\", \"Microsoft.Web/sites/config/list/action\"]\n",
"subComponents": []
}
]
Suggested fix
Publicly document and support the Alarms API endpoints - they are very useful
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 at the linked Prisma Cloud API documentation and inspect how existing endpoints are documented; use the /alarms endpoint and the referenced /account/{account id}/config/status endpoint as entry points. Done means the Alarms API endpoints are publicly documented and supported for customer use.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100