Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More details for Status Page APIs #755

Merged
merged 3 commits into from
Oct 16, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add headings
  • Loading branch information
jamesholland-uk committed Oct 15, 2024
commit f9d51880a2e50da544d65983b97301fad464ef9e
21 changes: 10 additions & 11 deletions products/cross-platform/docs/service-status-api.mdx
Original file line number Diff line number Diff line change
@@ -8,52 +8,51 @@ keywords:
- crossplatform
---

There is a Palo Alto Networks cross-platform Service Status page hosted at https://status.paloaltonetworks.com. There is documentation for the companion API for this Service Status, hosted at https://status.paloaltonetworks.com/api, which includes a Javascript wrapper and example code for consuming the API.
There is a Palo Alto Networks cross-platform Status Page hosted at https://status.paloaltonetworks.com. There is documentation for the companion API for this Status Page, hosted at https://status.paloaltonetworks.com/api, which includes a Javascript wrapper.

The API itself is delivered via Atlassian's StatusPage offering. This API provides a collections of endpoints which all return JSON formatted payloads. The API does not provide any built-in filtering; any filtering or parsing of responses should be done client-side, with the suggestion to use a JSON parsing library within the programming language of choice.

The endpoints available are described below.

The following endpoints are available:

Summary:
### Summary
https://status.paloaltonetworks.com/api/v2/summary.json
- Despite being called a summary, this provides details from the entire status page, including an overall status indicator for the entire portfolio, statuses of individual components, unresolved incidents, and any upcoming or in-progress scheduled maintenances.

Portfolio Status:
### Portfolio Status
https://status.paloaltonetworks.com/api/v2/status.json
- Provides just an overall status for the entire portfolio of products and services listed on the status page.
- Status indicator potential values: none, minor, major, critical

Product/Service (Component) Statuses:
### Product/Service (Component) Statuses
https://status.paloaltonetworks.com/api/v2/components.json
- Lists each product or service (component) from the status page with a status for each.
- Component status potential values: operational, degraded_performance, partial_outage, major_outage

Unresolved Incidents:
### Unresolved Incidents
https://status.paloaltonetworks.com/api/v2/incidents/unresolved.json
- Lists all incidents which are unresolved, with their impact and status.
- Incident impact potential values: none, minor, major, critical
- Incident status potential values: investigating, identified, monitoring

Recent Incidents:
### Recent Incidents
https://status.paloaltonetworks.com/api/v2/incidents.json
- Lists the most recent 50 incidents, whether they are resolved or unresolved, with their impact and status.
- Incident impact potential values: none, minor, major, critical
- Incident status potential values: investigating, identified, monitoring, resolved, postmortem

Upcoming Maintenance Events:
### Upcoming Maintenance Events
https://status.paloaltonetworks.com/api/v2/scheduled-maintenances/upcoming.json
- Lists upcoming events such as planned outages, upgrades, or general notices of work on products and services which may cause disruptions.
- Maintenance event status potential values: scheduled
- Maintenance event impact potential values: none, maintenance, minor, major, critical

Active Maintenance Events:
### Active Maintenance Events
https://status.paloaltonetworks.com/api/v2/scheduled-maintenances/active.json
- Lists upcoming events such as planned outages, upgrades, or general notices of work on products and services which may cause disruptions.
- Maintenance event status potential values: in progress, verifying
- Maintenance event impact potential values: none, maintenance, minor, major, critical

All Maintenance Events:
### All Maintenance Events
https://status.paloaltonetworks.com/api/v2/scheduled-maintenances.json
- Lists the most recent 50 maintenance events such as planned outages, upgrades, or general notices of work on products and services which may cause disruptions.
- Maintenance event status potential values: scheduled, in progress, verifying, completed