Install images

Obtain signed download URLs for the Broker VM installation images in the supported hypervisor formats (OVA, QCOW2, VHD, VHD_AZURE, VMDK).

Get a signed URL for a Broker VM install image

get

Return a short-lived signed URL for the Broker VM installation image in the requested hypervisor format. The signed URL is valid for direct download from object storage; the caller does not need to re-authenticate.

The request body carries the image type as a JSON object so the endpoint stays consistent with the other GET-but-with-body endpoints in this spec (the backend gates allow GET on this route and parse the body identically to a POST).

Required permission: broker_action.

Authorizations

AuthorizationstringRequired

The tenant API key value, sent as the literal Authorization header value (no Bearer prefix).

x-xdr-auth-idstringRequired

The tenant API key identifier corresponding to the value sent in Authorization.

Body

Body for downloadInstallImage. The type selector picks the hypervisor image format.

typestring · enumRequired

Hypervisor format of a Broker VM install image.

Possible values:

Responses

200

Signed download metadata.

application/json

Payload returned by downloadInstallImage. The download_url is a short-lived signed URL for direct image download.

image_typestring · enumRequired

Hypervisor format of a Broker VM install image.

Possible values:

download_urlstring · uriRequired

Short-lived signed URL for direct image download.

file_namestringRequired

Suggested filename for the download.

versionstring · nullableOptional

Broker VM platform version embedded in the image.

400

Request validation failed. errors is present when the failure originates from Pydantic schema validation; otherwise only description is populated.

application/json

401

Missing or invalid Authorization / x-xdr-auth-id credentials.

application/json

403

Authenticated caller lacks the broker_action permission, or the targeted broker is a cluster member and the operation is rejected at that level.

application/json

404

The targeted resource does not exist.

application/json

500

Unexpected server-side failure.

application/json

get/public_api/v1/brokers/images/

GET /public_api/v1/brokers/images/ HTTP/1.1
Host: api-cortex.paloaltonetworks.com
Authorization: YOUR_API_KEY
x-xdr-auth-id: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "type": "OVA"
}

{
  "image_type": "OVA",
  "download_url": "https://storage.example.com/broker/v10.2.0/broker-10.2.0.ova?signature=...",
  "file_name": "broker-10.2.0.ova",
  "version": "10.2.0"
}