Palo Alto Networks Applications API
The Applications API from Palo Alto Networks — 48 operation(s) for applications.
OpenAPI Specification
openapi: 3.2.0
info:
title: Palo Alto Networks Applications API
version: '1.0'
description: 'Operations tagged Applications across 5 of this provider''s published API definitions: palo-alto-access-browser-mgmt-prismaaccess-browser-management-latest-openapi.yaml, palo-alto-access-prisma-access-config-applications-openapi.yaml, palo-alto-cspm-applicationconfigmicroservice-openapi.json, palo-alto-cspm-applicationsearchmicroservice-openapi.json, palo-alto-scm-config-cloudngfw-objects-objects-june-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sase.paloaltonetworks.com
- url: https://api.prismacloud.io
- url: https://api2.prismacloud.io
- url: https://api3.prismacloud.io
- url: https://api4.prismacloud.io
- url: https://api.anz.prismacloud.io
- url: https://api.eu.prismacloud.io
- url: https://api2.eu.prismacloud.io
- url: https://api.gov.prismacloud.io
- url: https://api.prismacloud.cn
- url: https://api.ca.prismacloud.io
- url: https://api.sg.prismacloud.io
- url: https://api.uk.prismacloud.io
- url: https://api.ind.prismacloud.io
- url: https://api.jp.prismacloud.io
- url: https://api.fr.prismacloud.io
- url: https://api.strata.paloaltonetworks.com/config/objects/v1
description: Current
- url: https://api.sase.paloaltonetworks.com/sse/config/v1
description: Legacy
tags:
- name: Applications
paths:
/seb-api/v1/applications:
get:
summary: List all applications
description: Fetches all application objects, with support for filtering and pagination.
operationId: GetSeb-apiV1Applications
responses:
'200':
description: A list of all application objects
content:
application/json:
schema:
properties:
data:
type: array
items:
$ref: '#/components/schemas/ApplicationItem'
metadata:
$ref: '#/components/schemas/ResponseMetadata'
pageInfo:
$ref: '#/components/schemas/PageInfo'
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'404':
description: Resource Not found
'500':
description: Internal server error
parameters:
- in: query
name: type
schema:
type: string
enum:
- custom
- private
- non-web
- catalog
- localdesktopcustom
required: false
- in: query
name: name
schema:
type: string
description: Optional name to search in applications
required: false
- in: query
name: url
schema:
type: string
description: Optional URL to search in applications
required: false
- name: limit
in: query
description: Maximum number of applications to return
required: false
schema:
type: integer
format: int32
- name: cursor
in: query
description: An optional opaque string that defines from where to start listing
required: false
schema:
type: string
- in: query
name: sort
description: The field to sort by
required: false
schema:
type: string
enum:
- application.id
- application.name
- application.create_time
- application.update_time
- name: order
in: query
description: The sort order
required: false
schema:
$ref: '#/components/schemas/Order'
- name: configurationVersion
in: query
description: Configuration version to retrieve (draft, active, or version number)
required: false
schema:
type: string
default: draft
pattern: ^([dD]raft|[aA]ctive|[1-9][0-9]{0,9}|0CV[0-9A-Z]{26})$
tags:
- Applications
security:
- BearerAuth: []
/seb-api/v1/applications/{id}:
get:
summary: Get an application by ID
description: Fetches a specific application object identified by its unique ID.
operationId: GetSeb-apiV1Applicationsbyid
responses:
'200':
description: An Application
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationItem'
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'404':
description: Resource Not found
'500':
description: Internal server error
parameters:
- name: id
in: path
required: true
schema:
type: string
pattern: ^0AP[0-9A-HJKMNP-TV-Z]{26}$
description: Application ID.
- name: configurationVersion
in: query
description: Configuration version to retrieve (draft, active, or version number)
required: false
schema:
type: string
default: draft
pattern: ^([dD]raft|[aA]ctive|[1-9][0-9]{0,9}|0CV[0-9A-Z]{26})$
tags:
- Applications
security:
- BearerAuth: []
delete:
summary: Delete an application by ID
description: Permanently removes a specific application identified by its ID.
operationId: DeleteSeb-apiV1Applicationsbyid
responses:
'204':
description: Deleted successfully
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'404':
description: Resource Not found
'500':
description: Internal server error
parameters:
- name: id
in: path
required: true
schema:
type: string
pattern: ^0AP[0-9A-HJKMNP-TV-Z]{26}$
description: Application ID.
tags:
- Applications
security:
- BearerAuth: []
/seb-api/v1/applications/type/{type}:
get:
summary: List applications by type
description: Fetches application objects belonging to a specific type.
operationId: GetSeb-apiV1ApplicationsTypebytype
responses:
'200':
description: A list of all application objects
content:
application/json:
schema:
properties:
data:
type: array
items:
$ref: '#/components/schemas/ApplicationItem'
metadata:
$ref: '#/components/schemas/ResponseMetadata'
pageInfo:
$ref: '#/components/schemas/PageInfo'
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'500':
description: Internal server error
parameters:
- in: path
name: type
required: true
schema:
type: string
enum:
- custom
- private
- non-web
- catalog
- localdesktopcustom
- in: query
name: name
schema:
type: string
description: Optional name to search in applications
required: false
- in: query
name: url
schema:
type: string
description: Optional URL to search in applications
required: false
- name: configurationVersion
in: query
description: Configuration version to retrieve (draft, active, or version number)
required: false
schema:
type: string
default: draft
pattern: ^([dD]raft|[aA]ctive|[1-9][0-9]{0,9}|0CV[0-9A-Z]{26})$
- name: cursor
in: query
description: An optional opaque string that defines from where to start listing
required: false
schema:
type: string
- name: limit
in: query
description: Maximum number of applications to return
required: false
schema:
type: integer
format: int32
- in: query
name: sort
description: The field to sort by
required: false
schema:
type: string
enum:
- application.id
- application.name
- application.create_time
- application.update_time
- name: order
in: query
description: The sort order
required: false
schema:
$ref: '#/components/schemas/Order'
tags:
- Applications
security:
- BearerAuth: []
post:
summary: Create an application
description: Adds a new application of the specified type to the management console. **Uniform Resource Locator Limit:** For custom, private, and non-web applications, there is a tenant-wide limit of 15,000 URLs combined. Exceeding this limit returns a 400 Bad Request error.
operationId: PostSeb-apiV1ApplicationsTypebytype
responses:
'201':
description: Created successfully
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the newly created resource
required:
- id
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'409':
description: Conflict - resource already exists
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
parameters:
- in: path
name: type
required: true
schema:
type: string
enum:
- custom
- private
- non-web
- catalog
- localdesktopcustom
tags:
- Applications
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOrReplaceAppInput'
security:
- BearerAuth: []
/seb-api/v1/applications/type/{type}/{id}:
get:
summary: Get an application by ID by type
description: Fetches a specific application object belonging to the specified type.
operationId: GetSeb-apiV1ApplicationsTypeBy_typebyid
responses:
'200':
description: An Application
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationItem'
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'404':
description: Resource Not found
'500':
description: Internal server error
parameters:
- in: path
name: type
required: true
schema:
type: string
enum:
- custom
- private
- non-web
- catalog
- localdesktopcustom
- name: id
in: path
required: true
schema:
type: string
pattern: ^0AP[0-9A-HJKMNP-TV-Z]{26}$
description: Application ID.
- name: configurationVersion
in: query
description: Configuration version to retrieve (draft, active, or version number)
required: false
schema:
type: string
default: draft
pattern: ^([dD]raft|[aA]ctive|[1-9][0-9]{0,9}|0CV[0-9A-Z]{26})$
tags:
- Applications
security:
- BearerAuth: []
patch:
summary: Update an application
description: Partially updates an application - provided attributes are set as specified, others remain unchanged. **Uniform Resource Locator Limit:** For custom, private, and non-web applications, there is a tenant-wide limit of 15,000 URLs combined. Exceeding this limit returns a 400 Bad Request error.
operationId: PatchSeb-apiV1ApplicationsTypeBy_typebyid
responses:
'200':
description: Updated successfully
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The ID of the updated resource
required:
- id
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'404':
description: Resource Not found
'409':
description: Conflict - resource already exists
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
parameters:
- in: path
name: type
required: true
schema:
type: string
enum:
- custom
- private
- non-web
- catalog
- localdesktopcustom
- name: id
in: path
required: true
schema:
type: string
pattern: ^0AP[0-9A-HJKMNP-TV-Z]{26}$
description: Application ID.
tags:
- Applications
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchAppInput'
security:
- BearerAuth: []
delete:
summary: Delete an application by type
description: Removes an application of the specified type from the system.
operationId: DeleteSeb-apiV1ApplicationsTypeBy_typebyid
responses:
'204':
description: Deleted successfully
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'404':
description: Resource Not found
'500':
description: Internal server error
parameters:
- in: path
name: type
required: true
schema:
type: string
enum:
- custom
- private
- non-web
- catalog
- localdesktopcustom
- name: id
in: path
required: true
schema:
type: string
pattern: ^0AP[0-9A-HJKMNP-TV-Z]{26}$
description: Application ID.
tags:
- Applications
security:
- BearerAuth: []
/seb-api/v1/applications/categories:
get:
summary: List application categories
description: Retrieve the categories details through this Application Programming Interface endpoint.
operationId: GetSeb-apiV1ApplicationsCategories
responses:
'200':
description: A list of the available application categories
content:
application/json:
schema:
properties:
data:
type: array
items:
type: string
'403':
description: Forbidden
'500':
description: Internal server error
parameters: []
tags:
- Applications
security:
- BearerAuth: []
/seb-api/v1/applications/bulk-create/{type}:
post:
summary: Bulk create applications
description: Adds multiple new applications of the specified type to the management console in a single operation. **Uniform Resource Locator Limit:** For custom, private, and non-web applications, there is a tenant-wide limit of 15,000 URLs combined. Exceeding this limit returns a 400 Bad Request error.
operationId: bulkCreateApplications
responses:
'201':
description: Created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/BulkCreatedResponse'
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'409':
description: Conflict - resource already exists
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
parameters:
- in: path
name: type
required: true
schema:
type: string
enum:
- custom
- private
- non-web
- catalog
- localdesktopcustom
tags:
- Applications
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateOrReplaceAppInput'
maxItems: 1000
minItems: 1
security:
- BearerAuth: []
/seb-api/v1/applications/bulk-delete:
post:
summary: Bulk delete applications
description: Permanently removes multiple applications identified by their IDs in a single atomic operation.
operationId: PostSeb-apiV1ApplicationsBulk-delete
responses:
'204':
description: Deleted successfully
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
errorResponse:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
'404':
description: Resource Not found
'500':
description: Internal server error
parameters: []
tags:
- Applications
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
appIds:
type: array
items:
type: string
pattern: ^0AP[0-9A-HJKMNP-TV-Z]{26}$
description: Array of application IDs to be deleted
minItems: 1
maxItems: 2000
required:
- appIds
security:
- BearerAuth: []
/sse/config/v1/applications:
get:
description: 'Get applications.
'
operationId: get-sse-config-v1-applications
parameters:
- $ref: '#/components/parameters/limit-optional'
- $ref: '#/components/parameters/offset-optional'
- $ref: '#/components/parameters/name-optional'
- $ref: '#/components/parameters/folder'
responses:
'200':
content:
application/json:
schema:
properties:
data:
allOf:
- items:
$ref: '#/components/schemas/objects-applications'
type: array
limit:
default: 200
type: number
offset:
default: 0
type: number
total:
type: number
type: object
description: List of applications
'400':
$ref: '#/components/responses/bad_request_errors_basic'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'404':
$ref: '#/components/responses/not_found'
default:
$ref: '#/components/responses/default_errors'
security:
- Bearer: []
summary: List applications
tags:
- Applications
post:
description: 'Create an application.
'
operationId: post-sse-config-v1-applications
parameters:
- $ref: '#/components/parameters/folder'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/objects-applications'
description: The application you want to create
responses:
'201':
$ref: '#/components/responses/http_created'
'400':
$ref: '#/components/responses/bad_request_errors_basic_with_body'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'409':
$ref: '#/components/responses/conflict_errors'
default:
$ref: '#/components/responses/default_errors'
security:
- Bearer: []
summary: Create an application
tags:
- Applications
servers:
- url: https://api.sase.paloaltonetworks.com
/sse/config/v1/applications/{id}:
delete:
description: 'Delete an application.
'
operationId: delete-sse-config-v1-applications-id
parameters:
- $ref: '#/components/parameters/uuid-required'
responses:
'200':
$ref: '#/components/responses/http_ok'
'400':
$ref: '#/components/responses/bad_request_errors_basic'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'404':
$ref: '#/components/responses/not_found'
'409':
$ref: '#/components/responses/conflict_errors'
default:
$ref: '#/components/responses/default_errors'
security:
- Bearer: []
summary: Delete an application
tags:
- Applications
get:
description: 'Get an [application](https://docs.paloaltonetworks.com/network-security/security-policy/objects/applications) by ID.
'
operationId: get-sse-config-v1-applications-id
parameters:
- $ref: '#/components/parameters/uuid-required'
responses:
'200':
content:
application/json:
schema:
allOf:
- items:
$ref: '#/components/schemas/objects-applications'
type: array
description: Get the application by id.
'400':
$ref: '#/components/responses/bad_request_errors_basic'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'404':
$ref: '#/components/responses/not_found'
default:
$ref: '#/components/responses/default_errors'
security:
- Bearer: []
summary: Get an application by ID
tags:
- Applications
put:
description: 'Modify an application.
'
operationId: put-sse-config-v1-applications-id
parameters:
- $ref: '#/components/parameters/uuid-required'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/objects-applications'
description: The application you want to edit
responses:
'200':
$ref: '#/components/responses/http_ok'
'400':
$ref: '#/components/responses/bad_request_errors_basic_with_body'
'401':
$ref: '#/components/responses/auth_errors'
'403':
$ref: '#/components/responses/access_errors'
'404':
$ref: '#/components/responses/not_found'
'409':
$ref: '#/components/responses/conflict_errors'
default:
$ref: '#/components/responses/default_errors'
security:
- Bearer: []
summary: Edit an application
tags:
- Applications
servers:
- url: https://api.sase.paloaltonetworks.com
/appid/api/v1/download/app:
post:
tags:
- Applications
summary: Download Application Inventory
description: "You can download the complete application inventory list with the application details in a .csv format. \n>**Note:** You need `application` feature with `Read` permission to access this endpoint. Verify if your permission group includes this feature using the [Get Permission Group by ID](https://pan.dev/prisma-cloud/api/cspm/get-1/) endpoint. You can also check this in the Prisma Cloud console by ensuring that Application Inventory > Applications is enabled."
operationId: inventory-Application-Csv-Download
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationDownloadRequest'
required: true
responses:
'200':
description: Successful operation
content:
application/octet-stream:
schema:
type: array
items:
type: string
format: byte
'400':
description: Bad Request
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/ErrorResponse_2'
'401':
description: Unauthorized - user cannot be authenticated to service the request
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/ErrorResponse_2'
'403':
description: Forbidden - user is not authorized, or does not have the correct permissions, to make the call
content:
application/octet-stream:
schema:
$ref: '#/components/schemas/ErrorResponse_2'
'413':
description: Payload Too Large
content:
'*/*':
schema:
type: object
security:
- x-redlock-auth: []
x-public: 'true'
servers:
- url: https://api.prismacloud.io
- url: https://api2.prismacloud.io
- url: https://api3.prismacloud.io
- url: https://api4.prismacloud.io
- url: https://api.anz.prismacloud.io
- url: https://api.eu.prismacloud.io
- url: https://api2.eu.prismacloud.io
- url: https://api.gov.prismacloud.io
- url: https://api.prismacloud.cn
- url: https://api.ca.prismacloud.io
- url: https://api.sg.prismacloud.io
- url: https://api.uk.prismacloud.io
- url: https://api.ind.prismacloud.io
- url: https://api.jp.prismacloud.io
- url: https://api.fr.prismacloud.io
/appid/api/v1/app/criteria:
get:
tags:
- Applications
summary: Get Discovery Criteria
description: "Discovery criteria is a set of filter strings based on which the assets are scanned and grouped into applications. The discovery criteria can be a predefined criteria or a custom criteria. You can use this endpoint to download all discovery criteria details including the criteria that were deleted. \n>**Note:** You need `application` feature with `Read` permission to access this endpoint. Verify if your permission group includes this feature using the [Get Permission Group by ID](https://pan.dev/prisma-cloud/api/cspm/get-1/) endpoint. You can also check this in the Prisma Cloud console by ensuring that Application Inventory > Applications is enabled."
operationId: get_4
parameters:
- name: fetch_deleted
in: query
description: True to get deleted criteria; False to exclude the deleted criteria.
required: false
schema:
type: boolean
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
'400':
description: Bad Request - request body contains a query that is not grammatically valid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse_2'
'401':
description: Unauthorized - user cannot be authenticated to service the request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse_2'
'403':
description: Forbidden - user is not authorized, or does not have the correct permissions, to make the call
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse_2'
'413':
description: Payload Too Large
content:
'*/*':
schema:
type: object
security:
- x-redlock-auth: []
x-public: 'true'
post:
tags:
- Applications
summary: Create Discovery Criteria
description: "Create a new custom discovery criteria. \n>**Note:** You need `application` feature with `Create or Update` permission to access this endpoint. Verify if your permission group includes this feature using the [Get Permission Group by ID](https://pan.dev/prisma-cloud/api/cspm/get-1/) endpoint. You can also check this in the Prisma Cloud console by ensuring that Application Inventory > Applications is enabled."
operationId: create_1
parameters:
- name: create_definition
in: query
description: boolean value indicating if definition has to be created
required: false
schema:
type: boolean
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AppCriteriaRequest'
required: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
'400':
description: Bad Request - request body contains a query that is not grammatically valid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse_2'
'401':
description: Unauthorized - user cannot be authenticated to service the request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse_2'
'403':
description: Forbidden - user is not authorized, or does not have the correct permissions, to make the call
content:
application/json:
schema:
$re
# --- truncated at 32 KB (160 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-applications-api-openapi.yml