Skip to main content

Generate BPA Report

POST 
/bpa/v1/requests

Initiates the BPA report generation process using the configurable options.

When you use a POST request to initiate a report generation, the response contains an upload-url field. This field contains a signed URL. Use the signed URL to upload a PAN-OS configuration file to generate the report.

The id field contains the report generation job ID that you can use to track the report generation completion status. The generation time can vary depending on the size of the configuration file. For configuartion files under 100 megabytes, you can expect a report in about 10 seconds. You can request the status of a generated BPA report to get the current completion status.

Below is an example curl request you can use to upload your XML configuration file to the generated signed-URL you receive in the response: 

curl -X PUT --upload-file ${path/to/file} '${signed-upload-url}'

Request​

Body

    family required

    Possible values: [7000f, 5400f, 5200f, 5000f, 3400f, 3200f, 3000f, 1400f, 800f, 400f, 220f, vm, m]

    The platform family of the device.

    model required

    Possible values: [PA-7080, PA-7050, PA-5450, PA-5440, PA-5430, PA-5420, PA-5410, PA-5280, PA-5260, PA-5240, PA-5220, PA-5060, PA-5050, PA-5020, PA-3440, PA-3430, PA-3420, PA-3410, PA-3260, PA-3250, PA-3220, PA-3050, PA-3020, PA-1420, PA-1410, PA-850, PA-820, PA-460, PA-450, PA-445, PA-440, PA-415, PA-410, PA-220, PA-220R, Panorama]

    The model of the device.

    requester-email emailrequired

    The email address of the person requesting the BPA report.

    requester-name stringrequired

    The name of the person requesting the BPA report.

    serial stringrequired

    The serial number of the device.

    version stringrequired

    The PAN-OS version of the device. The API supports versions such as 11.0 or 11.0.1.

Responses​

Generated the BPA Report

Schema
    id uuid

    The generated report ID.

    family required

    Possible values: [7000f, 5400f, 5200f, 5000f, 3400f, 3200f, 3000f, 1400f, 800f, 400f, 220f, vm, m]

    The platform family of the device.

    model required

    Possible values: [PA-7080, PA-7050, PA-5450, PA-5440, PA-5430, PA-5420, PA-5410, PA-5280, PA-5260, PA-5240, PA-5220, PA-5060, PA-5050, PA-5020, PA-3440, PA-3430, PA-3420, PA-3410, PA-3260, PA-3250, PA-3220, PA-3050, PA-3020, PA-1420, PA-1410, PA-850, PA-820, PA-460, PA-450, PA-445, PA-440, PA-415, PA-410, PA-220, PA-220R, Panorama]

    The model of the device.

    requester-email emailrequired

    The email address of the person requesting the BPA report.

    requester-name stringrequired

    The name of the person requesting the BPA report.

    serial stringrequired

    The serial number of the device.

    version stringrequired

    The PAN-OS version of the device. The API supports versions such as 11.0 or 11.0.1.

    upload-url uri

    The signed URL that will be used to upload the PAN-OS configuration file.

Loading...