Palo Alto Networks Data Resource Export API
The DataResourceExport API from Palo Alto Networks — 4 operation(s) for dataresourceexport.
OpenAPI Specification
openapi: 3.2.0
info:
contact: {}
description: 'Export data resources.
'
title: Data Resource Export API
version: '2.0'
servers:
- url: https://pa-us.api.prismaaccess.com
tags:
- name: DataResourceExport
paths:
/api/sase/v2.0/resource/download:
post:
description: 'Download a CSV file containing the results of a request for custom resources.
The query for this information is created using Export Custom Resource.
'
operationId: post-api-sase-v2.0-resource-download
parameters:
- description: Unique tenant ID.
in: path
name: tenant_id
required: true
schema:
type: string
- description: Sub-tenant ID. This parameter is required only if a sub-tenant is configured.
in: header
name: Prisma-SubTenant
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
description: '
The JSON request object
'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DataResponse'
description: List of data objects
'400':
content:
application/json:
schema:
description: Error Response
example:
details: Resource property 'property1' is not valid
errorCode: DATA10002
message: Invalid Resource property name
values:
- property1
properties:
details:
description: Error details
example: Input value 'property1' is not valid
type: string
errorCode:
description: Error code
example: REST10001
type: string
message:
description: Error Message
example: Invalid input
type: string
values:
allOf:
- $ref: '#/components/schemas/ListString'
- description: Values in error details. Used to construct error in different language
example:
- property1
required:
- errorCode
- message
- details
- values
type: object
description: '
Invalid Resource Query request responses
1. Invalid Resource property name (Error code: DATA10002)
2. Invalid Resource request parameter (Error code: DATA10003)
3. The resource or property is not licensed (Error code: DATA10004)
'
'403':
content:
application/json:
schema:
description: Error Response
example:
details: Permission Denied
errorCode: REST10003
message: Permission Denied
values:
- value1
properties:
details:
description: Error details
example: Input value 'property1' is not valid
type: string
errorCode:
description: Error code
example: REST10001
type: string
message:
description: Error Message
example: Invalid input
type: string
values:
allOf:
- $ref: '#/components/schemas/ListString'
- description: Values in error details. Used to construct error in different language
example:
- property1
required:
- errorCode
- message
- details
- values
type: object
description: '
Permission response
1. Permission Denied (Error code: REST10003)
'
'404':
content:
application/json:
schema:
description: Error Response
example:
details: Resource not found
errorCode: REST10002
message: Resource not found
values:
- value1
properties:
details:
description: Error details
example: Input value 'property1' is not valid
type: string
errorCode:
description: Error code
example: REST10001
type: string
message:
description: Error Message
example: Invalid input
type: string
values:
allOf:
- $ref: '#/components/schemas/ListString'
- description: Values in error details. Used to construct error in different language
example:
- property1
required:
- errorCode
- message
- details
- values
type: object
description: '
Resource not available response
1. Resource not found (Error code: REST10002)
'
'500':
content:
application/json:
schema:
description: Error Response
example:
details: Failed to process request
errorCode: REST10001
message: Unexpected server error
values:
- value1
properties:
details:
description: Error details
example: Input value 'property1' is not valid
type: string
errorCode:
description: Error code
example: REST10001
type: string
message:
description: Error Message
example: Invalid input
type: string
values:
allOf:
- $ref: '#/components/schemas/ListString'
- description: Values in error details. Used to construct error in different language
example:
- property1
required:
- errorCode
- message
- details
- values
type: object
description: '
Unexpected server error response
1. Unexpected server error (Error code: REST10001)
'
summary: Download custom resource
tags:
- DataResourceExport
/api/sase/v2.0/resource/download/status:
post:
description: 'Retrieve the status of a custom resource request job.
'
operationId: post-api-sase-v2.0-resource-download-status
parameters:
- description: Unique tenant ID.
in: path
name: tenant_id
required: true
schema:
type: string
- description: Sub-tenant ID. This parameter is required only if a sub-tenant is configured.
in: header
name: Prisma-SubTenant
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
description: '
The JSON request object
'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DataResponse'
description: List of data objects
'400':
content:
application/json:
schema:
description: Error Response
example:
details: Resource property 'property1' is not valid
errorCode: DATA10002
message: Invalid Resource property name
values:
- property1
properties:
details:
description: Error details
example: Input value 'property1' is not valid
type: string
errorCode:
description: Error code
example: REST10001
type: string
message:
description: Error Message
example: Invalid input
type: string
values:
allOf:
- $ref: '#/components/schemas/ListString'
- description: Values in error details. Used to construct error in different language
example:
- property1
required:
- errorCode
- message
- details
- values
type: object
description: '
Invalid Resource Query request responses
1. Invalid Resource property name (Error code: DATA10002)
2. Invalid Resource request parameter (Error code: DATA10003)
3. The resource or property is not licensed (Error code: DATA10004)
'
'403':
content:
application/json:
schema:
description: Error Response
example:
details: Permission Denied
errorCode: REST10003
message: Permission Denied
values:
- value1
properties:
details:
description: Error details
example: Input value 'property1' is not valid
type: string
errorCode:
description: Error code
example: REST10001
type: string
message:
description: Error Message
example: Invalid input
type: string
values:
allOf:
- $ref: '#/components/schemas/ListString'
- description: Values in error details. Used to construct error in different language
example:
- property1
required:
- errorCode
- message
- details
- values
type: object
description: '
Permission response
1. Permission Denied (Error code: REST10003)
'
'404':
content:
application/json:
schema:
description: Error Response
example:
details: Resource not found
errorCode: REST10002
message: Resource not found
values:
- value1
properties:
details:
description: Error details
example: Input value 'property1' is not valid
type: string
errorCode:
description: Error code
example: REST10001
type: string
message:
description: Error Message
example: Invalid input
type: string
values:
allOf:
- $ref: '#/components/schemas/ListString'
- description: Values in error details. Used to construct error in different language
example:
- property1
required:
- errorCode
- message
- details
- values
type: object
description: '
Resource not available response
1. Resource not found (Error code: REST10002)
'
'500':
content:
application/json:
schema:
description: Error Response
example:
details: Failed to process request
errorCode: REST10001
message: Unexpected server error
values:
- value1
properties:
details:
description: Error details
example: Input value 'property1' is not valid
type: string
errorCode:
description: Error code
example: REST10001
type: string
message:
description: Error Message
example: Invalid input
type: string
values:
allOf:
- $ref: '#/components/schemas/ListString'
- description: Values in error details. Used to construct error in different language
example:
- property1
required:
- errorCode
- message
- details
- values
type: object
description: '
Unexpected server error response
1. Unexpected server error (Error code: REST10001)
'
summary: Custom resource request status
tags:
- DataResourceExport
/api/sase/v2.0/resource/export/schedule/query/{resource_name}:
post:
description: 'Export a general resource. The result of this job is a CSV file that identifies all of the resource''s properties.
'
operationId: post-api-sase-v2.0-resource-export-schedule-query-resource_name
parameters:
- description: Name of the custom resource for which you want to select information.
in: path
name: resource_name
required: true
schema:
type: string
- description: Unique tenant ID.
in: path
name: tenant_id
required: true
schema:
type: string
- description: Sub-tenant ID. This parameter is required only if a sub-tenant is configured.
in: header
name: Prisma-SubTenant
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DataResourceQuery'
description: 'The JSON object used to query the resource. The query consists of four parts, show below.
1. Properties - Data fields to include in the query output.
2. Query - Filter conditions to apply to the query.
3. Sort - Sort order for the the data.
4. Count - Maximum number of records to retrieve.
'
required: true
responses:
'200':
content:
application/json:
schema:
type: object
description: Content as attachment
'400':
content:
application/json:
schema:
description: Error Response
example:
details: Resource property 'property1' is not valid
errorCode: DATA10002
message: Invalid Resource property name
values:
- property1
properties:
details:
description: Error details
example: Input value 'property1' is not valid
type: string
errorCode:
description: Error code
example: REST10001
type: string
message:
description: Error Message
example: Invalid input
type: string
values:
allOf:
- $ref: '#/components/schemas/ListString'
- description: Values in error details. Used to construct error in different language
example:
- property1
required:
- errorCode
- message
- details
- values
type: object
description: '
Invalid Resource Query request responses
1. Invalid Resource property name (Error code: DATA10002)
2. Invalid Resource request parameter (Error code: DATA10003)
3. The resource or property is not licensed (Error code: DATA10004)
'
'403':
content:
application/json:
schema:
description: Error Response
example:
details: Permission Denied
errorCode: REST10003
message: Permission Denied
values:
- value1
properties:
details:
description: Error details
example: Input value 'property1' is not valid
type: string
errorCode:
description: Error code
example: REST10001
type: string
message:
description: Error Message
example: Invalid input
type: string
values:
allOf:
- $ref: '#/components/schemas/ListString'
- description: Values in error details. Used to construct error in different language
example:
- property1
required:
- errorCode
- message
- details
- values
type: object
description: '
Permission response
1. Permission Denied (Error code: REST10003)
'
'404':
content:
application/json:
schema:
description: Error Response
example:
details: Resource not found
errorCode: REST10002
message: Resource not found
values:
- value1
properties:
details:
description: Error details
example: Input value 'property1' is not valid
type: string
errorCode:
description: Error code
example: REST10001
type: string
message:
description: Error Message
example: Invalid input
type: string
values:
allOf:
- $ref: '#/components/schemas/ListString'
- description: Values in error details. Used to construct error in different language
example:
- property1
required:
- errorCode
- message
- details
- values
type: object
description: '
Resource not available response
1. Resource not found (Error code: REST10002)
'
'500':
content:
application/json:
schema:
description: Error Response
example:
details: Failed to process request
errorCode: REST10001
message: Unexpected server error
values:
- value1
properties:
details:
description: Error details
example: Input value 'property1' is not valid
type: string
errorCode:
description: Error code
example: REST10001
type: string
message:
description: Error Message
example: Invalid input
type: string
values:
allOf:
- $ref: '#/components/schemas/ListString'
- description: Values in error details. Used to construct error in different language
example:
- property1
required:
- errorCode
- message
- details
- values
type: object
description: '
Unexpected server error response
1. Unexpected server error (Error code: REST10001)
'
summary: Export general resource
tags:
- DataResourceExport
/api/sase/v2.0/resourceexport/schedule/custom/query/{feature_name}/{resource_name}:
post:
description: "Creates a job that retrieves custom resource information. The results of this job will differ \ndepending on the feature and resource name that you provide. \nThe following feature/resource name combinations are supported:\n\n* mobileusers/mu_concurrent_connected_status\n\n Provides data on connected mobile users.\n\n* locations/location_mobilegateways_status\n\n Provides data on mobile users service availability.\n"
operationId: post-api-sase-v2.0-resourceexport-schedule-custom-query-feature_name-resource_name
parameters:
- description: Name of the custom feature for which you want to select information.
in: path
name: feature_name
required: true
schema:
type: string
- description: Name of the custom resource for which you want to select information.
in: path
name: resource_name
required: true
schema:
type: string
- description: Unique tenant ID.
in: path
name: tenant_id
required: true
schema:
type: string
- description: Sub-tenant ID. This parameter is required only if a sub-tenant is configured.
in: header
name: Prisma-SubTenant
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DataResourceQuery'
description: '
The JSON request object
'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DataResponse'
description: List of data objects
'400':
content:
application/json:
schema:
description: Error Response
example:
details: Resource property 'property1' is not valid
errorCode: DATA10002
message: Invalid Resource property name
values:
- property1
properties:
details:
description: Error details
example: Input value 'property1' is not valid
type: string
errorCode:
description: Error code
example: REST10001
type: string
message:
description: Error Message
example: Invalid input
type: string
values:
allOf:
- $ref: '#/components/schemas/ListString'
- description: Values in error details. Used to construct error in different language
example:
- property1
required:
- errorCode
- message
- details
- values
type: object
description: '
Invalid Resource Query request responses
1. Invalid Resource property name (Error code: DATA10002)
2. Invalid Resource request parameter (Error code: DATA10003)
3. The resource or property is not licensed (Error code: DATA10004)
'
'403':
content:
application/json:
schema:
description: Error Response
example:
details: Permission Denied
errorCode: REST10003
message: Permission Denied
values:
- value1
properties:
details:
description: Error details
example: Input value 'property1' is not valid
type: string
errorCode:
description: Error code
example: REST10001
type: string
message:
description: Error Message
example: Invalid input
type: string
values:
allOf:
- $ref: '#/components/schemas/ListString'
- description: Values in error details. Used to construct error in different language
example:
- property1
required:
- errorCode
- message
- details
- values
type: object
description: '
Permission response
1. Permission Denied (Error code: REST10003)
'
'404':
content:
application/json:
schema:
description: Error Response
example:
details: Resource not found
errorCode: REST10002
message: Resource not found
values:
- value1
properties:
details:
description: Error details
example: Input value 'property1' is not valid
type: string
errorCode:
description: Error code
example: REST10001
type: string
message:
description: Error Message
example: Invalid input
type: string
values:
allOf:
- $ref: '#/components/schemas/ListString'
- description: Values in error details. Used to construct error in different language
example:
- property1
required:
- errorCode
- message
- details
- values
type: object
description: '
Resource not available response
1. Resource not found (Error code: REST10002)
'
'500':
content:
application/json:
schema:
description: Error Response
example:
details: Failed to process request
errorCode: REST10001
message: Unexpected server error
values:
- value1
properties:
details:
description: Error details
example: Input value 'property1' is not valid
type: string
errorCode:
description: Error code
example: REST10001
type: string
message:
description: Error Message
example: Invalid input
type: string
values:
allOf:
- $ref: '#/components/schemas/ListString'
- description: Values in error details. Used to construct error in different language
example:
- property1
required:
- errorCode
- message
- details
- values
type: object
description: '
Unexpected server error response
1. Unexpected server error (Error code: REST10001)
'
summary: Export custom resource
tags:
- DataResourceExport
components:
schemas:
SortCondition:
properties:
order:
$ref: '#/components/schemas/Order'
sequence:
format: int32
type: integer
type: object
ListObject:
items: {}
type: array
DataResourceQuery:
description: Data resource query request
properties:
addOnFilter:
allOf:
- $ref: '#/components/schemas/FilterCondition'
- description: Add on data Filter Condition. (The existing property will be replaced)
computeDataRowsProcessed:
description: Flag to indicate total rows processed for query
type: boolean
count:
default: 10000
description: Maximum number of records
example: 3000
format: int32
maximum: 10000
minimum: 1
type: integer
filter:
allOf:
- $ref: '#/components/schemas/FilterCondition'
- description: Filter Condition
histogram:
allOf:
- $ref: '#/components/schemas/HistogramCondition'
- description: Histogram Condition
includeRecordNumber:
description: Flag to indicate add row number to response
type: boolean
properties:
allOf:
- $ref: '#/components/schemas/ListQueryProperty'
- description: Resource properties
example:
- property: property1
- function: sum
property: property2
sort:
order: desc
sequence: 1
- alias: average_property3
function: avg
property: property3
required:
- properties
- filter
type: object
HistogramCondition:
properties:
alias:
description: Property Alias
example: property1_alias
type: string
enableEmptyInterval:
description: Enable filling empty record for intervals with no data
example: true
type: boolean
property:
description: Property
example: property1
type: string
range:
allOf:
- $ref: '#/components/schemas/Range'
- description: Histogram Range
example: hour
sort:
allOf:
- $ref: '#/components/schemas/SortCondition'
- description: Sort Condition (optional)
example:
order: desc
sequence: 1
value:
description: Histogram range value (only 1 is supported)
example: 1
format: int32
type: integer
required:
- property
- range
type: object
DataResponse:
description: Resource Request response
properties:
data:
allOf:
- $ref: '#/components/schemas/ListMapStringObject'
- description: Response Data
example:
- average_property3: 1
# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-dataresourceexport-api-openapi.yml