Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
Original file line number Diff line number Diff line change
@@ -1,31 +1,60 @@
openapi: 3.0.3
info:
title: Best Practice Assessment (BPA) Config Upload API
version: 1.1.0
description: "The Best Practice Assessment (BPA) Config Upload API provides a streamlined,\
\ \nprogrammatic way for organizations to audit their security posture. \nBy integrating\
\ this API into your workflow, you can automatically submit configuration files\
\ from \nPalo Alto Networks Panorama or Next-Generation Firewalls (NGFW) and receive\
\ a comprehensive assessment\nbased on industry-standard security benchmarks.\n\
The service parses your configuration, identifies potential security gaps, and\n\
returns a detailed JSON-formatted report. This allows your team to ingest data\
\ directly \ninto custom dashboards, SIEMs, or other automations.\n\nKey Features\
\ and Security\n\n We understand that configuration files contain sensitive\
\ architectural data. \n This API is built with a security-first architecture\
\ to ensure your data remains protected:\n - Secure Transmission: All data\
\ is encrypted in transit using industry-standard TLS protocols.\n - Privacy\
\ Control (Zero Persistence): The API includes an optional flag that instructs\
\ the service \n to delete the configuration file immediately after the report\
\ is generated. \n This ensures that none of your sensitive information is\
\ stored in the cloud environment.\n - Actionable JSON Output: Instead of static\
\ PDFs, the API delivers structured data, \n making it machine readable and\
\ easily processed.\n\nWorkflow Overview\n\n 1. Export: Generate a configuration\
\ file from your Panorama or NGFW.\n 2. Upload: Submit the file to the config\
\ upload endpoint via a secure POST request.\n 3. Process: The engine analyzes\
\ the configuration against hundreds of best-practice checks.\n 4. Retrieve:\
\ Receive the results instantly in a structured JSON schema.\n 5. Purge: (Optional)\
\ The service automatically deletes the source configuration file upon completion.\
\ This Open API spec file was created on April 10, 2026. \xA9 2026 Palo Alto Networks,\
title: 'Posture Management and Assessment API: BPA, Custom Checks, and Compliance'
version: '1.0'
description: "The Posture Management and Assessment API suite provides a streamlined,\
\ programmatic way for organizations to audit, manage, and enforce their security\
\ posture. By integrating these APIs into your workflow, you can automate security\
\ assessments, manage customized posture checks, and ensure continuous alignment\
\ with industry-standard security benchmarks and your organization's unique requirements.\n\
Best Practice Assessment (BPA) Config Upload API\nThe Best Practice Assessment\
\ (BPA) Config Upload API enables automated submission of configuration files\
\ from Palo Alto Networks Panorama or Next-Generation Firewalls (NGFW) to receive\
\ a comprehensive assessment based on predefined, industry-standard security best\
\ practices. The service parses your configuration, identifies potential security\
\ gaps, and returns a detailed JSON-formatted report, allowing your team to ingest\
\ data directly into custom dashboards, SIEMs, or other automations.\n\nKey Features\
\ and Security\n\nWe understand that configuration files contain sensitive architectural\
\ data. This API is built with a security-first architecture to ensure your data\
\ remains protected\n\n - Secure Transmission- All data is encrypted in transit\
\ using industry-standard TLS protocols.\n - Privacy Control (Zero Persistence)-\
\ The API includes an optional flag that instructs the service to delete the configuration\
\ file immediately after the report is generated. This ensures that none of your\
\ sensitive information is stored in the cloud environment.\n - Actionable JSON\
\ Output- Instead of static PDFs, the API delivers structured data, making it\
\ machine-readable and easily processed.\n\nBPA Workflow Overview\n\n - Export-\
\ Generate a configuration file from your Panorama or NGFW.\n - Upload- Submit\
\ the file to the config upload endpoint via a secure POST request.\n - Process-\
\ The engine analyzes the configuration against hundreds of pre-defined best-practice\
\ checks.\n - Retrieve- Receive the results instantly in a structured JSON schema.\n\
\ - Purge- (Optional) The service automatically deletes the source configuration\
\ file upon completion.\n \nCustom Posture Check Management (Pro License Required)\n\
\n While the BPA Config Upload API validates against pre-defined best practices,\
\ our Custom Posture Check endpoints give Pro-licensed users the ability to manage\
\ and report on user-defined posture checks tailored to specific organizational\
\ policies.\n\nThese endpoints provide full lifecycle management for Custom Posture\
\ Checks\n\n - List Checks- Retrieve all custom posture checks in your environment.\n\
\ - Create Checks- Define new custom security posture rules.\n - Retrieve (Get)\
\ Checks- Fetch the details of a specific posture check by its ID.\n - Update\
\ Checks- Modify existing checks to adapt to evolving security policies.\n -\
\ Delete Checks- Remove outdated or unnecessary checks by ID.\n - Clone Checks-\
\ Quickly duplicate an existing check to use as a template for a new one.\n -\
\ Batch Upsert- Create or update multiple custom posture checks in a single API\
\ call for efficient bulk management.\n - Batch Delete- Remove multiple posture\
\ checks simultaneously.\n\n**Note** These endpoints are strictly for the management\
\ and reporting of Custom Posture Checks and require a Pro license.\n\n**Coming\
\ Soon** Compliance Management and Reporting\n\n We are continuously expanding\
\ our API capabilities to help you maintain a robust security posture. Soon,\n\
\ we will be introducing endpoints for Compliance Management and Reporting. This\
\ upcoming feature set will \n allow organizations to automatically map their\
\ network security configurations and posture check results\n directly against\
\ major regulatory frameworks and compliance standards, streamlining audit preparations,\
\ \n continuous compliance tracking and evidence collection.\n This Open API\
\ spec file was created on April 10, 2026. \xA9 2026 Palo Alto Networks, Inc.\
\ Palo Alto Networks \n is a registered trademark of Palo Alto Networks. \n \
\ A list of our trademarks can be found at https://www.paloaltonetworks.com/company/trademarks.html.\
\ \n All other marks mentioned herein may be trademarks of their respective companies.\
\ This Open API spec file was created on May 23, 2026. \xA9 2026 Palo Alto Networks,\
\ Inc. Palo Alto Networks is a registered trademark of Palo Alto Networks. A list\
\ of our trademarks can be found at [https://www.paloaltonetworks.com/company/trademarks.html](https://www.paloaltonetworks.com/company/trademarks.html).\
\ All other marks mentioned herein may be trademarks of their respective companies."
Expand Down
9 changes: 1 addition & 8 deletions products/scm/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -327,14 +327,7 @@ module.exports = {
type: "category",
label: "Checks",
collapsed: true,
items: [
{
type: "category",
label: "Reports",
collapsed: true,
items: [require("./api/config/posture-management/sidebar")],
},
],
items: [require("./api/config/posture-management/sidebar")],
},
],
},
Expand Down
Loading