Palo Alto Networks Data Resource Export API

The DataResourceExport API from Palo Alto Networks — 4 operation(s) for dataresourceexport.

Operations 4

POST /api/sase/v2.0/resource/download Download custom resource #
POST /api/sase/v2.0/resource/download/status Custom resource request status #
POST /api/sase/v2.0/resource/export/schedule/query/{resource_name} Export general resource #
POST /api/sase/v2.0/resourceexport/schedule/custom/query/{feature_name}/{resource_name} Export custom resource #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/palo-alto-networks-dataresourceexport-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

palo-alto-networks-dataresourceexport-api-openapi.yml Raw ↑
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:
    ListObject:
      items: {}
      type: array
    QueryRule:
      properties:
        escapeValue:
          description: Enable character escaping for value
          example: true
          type: boolean
        format:
          allOf:
          - $ref: '#/components/schemas/NumberFormat'
          - description: Number Format function (optional)
            example:
              function: round
              value: 1
        operator:
          allOf:
          - $ref: '#/components/schemas/Operator'
          - description: Operator
            example: in
        property:
          description: Resource Property
          example: property1
          type: string
        subQuery:
          allOf:
          - $ref: '#/components/schemas/SubQuery'
          - description: Subquery (optional)
            example:
              type: local
              value: sub_query1
        values:
          allOf:
          - $ref: '#/components/schemas/ListObject'
          - description: Operator
            example:
            - value1
            - value2
      required:
      - property
      - operator
      - values
      - escapeValue
      type: object
    ListQueryProperty:
      items:
        $ref: '#/components/schemas/QueryProperty'
      type: array
    MapStringObject:
      properties:
        empty:
          type: boolean
      type: object
    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
    ListMapStringObject:
      items:
        $ref: '#/components/schemas/MapStringObject'
      typ

# --- 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