Palo Alto Networks Vulnerability Protection Signatures API
Vulnerability Protection Signatures
OpenAPI Specification
openapi: 3.2.0
info:
version: 2.0.0
title: Security Services Vulnerability Protection Signatures API
description: These APIs are used for defining and managing security services configurations within Strata Cloud Manager.
termsOfService: https://www.paloaltonetworks.com/content/dam/pan/en_US/assets/pdf/legal/palo-alto-networks-end-user-license-agreement-eula.pdf
contact:
email: support@paloaltonetworks.com
name: Palo Alto Networks Technical Support
url: https://support.paloaltonetworks.com
license:
name: MIT
url: https://opensource.org/license/mit
servers:
- url: https://api.strata.paloaltonetworks.com/config/security/v1
description: Current
- url: https://api.sase.paloaltonetworks.com/sse/config/v1
description: Legacy
security:
- scmToken: []
tags:
- name: Vulnerability Protection Signatures
description: Vulnerability Protection Signatures
paths:
/vulnerability-protection-signatures:
get:
tags:
- Vulnerability Protection Signatures
summary: List vulnerability protection signatures
description: 'Retrieve a list of vulnerability protection signatures.
'
operationId: ListVulnerabilityProtectionSignatures
parameters:
- $ref: '#/components/parameters/folder'
- $ref: '#/components/parameters/snippet'
- $ref: '#/components/parameters/device'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
allOf:
- type: array
items:
$ref: '#/components/schemas/vulnerability-protection-signatures'
limit:
type: integer
default: 200
offset:
type: integer
default: 0
total:
type: integer
'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'
post:
tags:
- Vulnerability Protection Signatures
summary: Create a vulnerability protection signature
description: 'Create a new vulnerability protection signature.
'
operationId: CreateVulnerabilityProtectionSignatures
requestBody:
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/vulnerability-protection-signatures'
responses:
'201':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/vulnerability-protection-signatures'
'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'
/vulnerability-protection-signatures/{id}:
get:
tags:
- Vulnerability Protection Signatures
summary: Get a vulnerability protection signature
description: 'Get an existing vulnerability protection signature.
'
operationId: GetVulnerabilityProtectionSignaturesByID
parameters:
- $ref: '#/components/parameters/uuid'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/vulnerability-protection-signatures'
'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'
put:
tags:
- Vulnerability Protection Signatures
summary: Update a vulnerability protection signature
description: 'Update an existing vulnerability protection signature.
'
operationId: UpdateVulnerabilityProtectionSignaturesByID
parameters:
- $ref: '#/components/parameters/uuid'
requestBody:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/vulnerability-protection-signatures'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/vulnerability-protection-signatures'
'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'
delete:
tags:
- Vulnerability Protection Signatures
summary: Delete a vulnerability protection signature
description: 'Delete a vulnerability protection signature.
'
operationId: DeleteVulnerabilityProtectionSignaturesByID
parameters:
- $ref: '#/components/parameters/uuid'
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'
components:
examples:
json_401_panui_auth_key_expired:
summary: Key Expired
value:
_errors:
- code: E016
message: Key Expired
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_501_panui_restapi_method_not_supported:
summary: Method Not Supported
value:
_errors:
- code: E012
message: Method Not Supported
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_restapi_input_format_mismatch:
summary: Input Format Mismatch
value:
_errors:
- code: E003
message: 'Input Format Mismatch: input-format=json'
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_501_panui_restapi_version_not_supported:
summary: Version Not Supported
value:
_errors:
- code: E012
message: Version Not Supported
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_409_panui_mgmt_name_not_unique:
summary: Name Not Unique
value:
_errors:
- code: E006
message: Name Not Unique
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_409_panui_mgmt_object_not_unique:
summary: Object Not Unique
value:
_errors:
- code: E016
message: Object Not Unique
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_404_panui_mgmt_object_not_present:
summary: Object Not Present
value:
_errors:
- code: E005
message: Object Not Present
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_restapi_missing_body:
summary: Missing Body
value:
_errors:
- code: E003
message: Missing Body
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_409_panui_mgmt_reference_not_zero:
summary: Reference Not Zero
value:
_errors:
- code: E009
message: Reference Not Zero
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_mgmt_invalid_command:
summary: Invalid Command
value:
_errors:
- code: E003
message: Invalid Command
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_restapi_output_format_mismatch:
summary: Output Format Mismatch
value:
_errors:
- code: E003
message: 'Output Format Mismatch: output-format=json Accept=xml'
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_401_panui_auth_not_authenticated:
summary: Not Authenticated
value:
_errors:
- code: E016
message: Not Authenticated
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_401_panui_auth_invalid_credential:
summary: Invalid Credential
value:
_errors:
- code: E016
message: Invalid Credential
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_403_panui_auth_unauthorized:
summary: Unauthorized
value:
_errors:
- code: E007
message: Unauthorized
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_restapi_missing_query_parameter:
summary: Missing Query Parameter
value:
_errors:
- code: E003
message: 'Missing Query Parameter: name'
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_405_panui_restapi_action_not_supported:
summary: Action Not Supported
value:
_errors:
- code: E012
message: 'Action Not Supported: move'
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_restapi_invalid_query_parameter:
summary: Invalid Query Parameter
value:
_errors:
- code: E003
message: 'Invalid Query Parameter: location=invalid'
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_401_panui_auth_key_too_long:
summary: Key Too Long
value:
_errors:
- code: E016
message: Key Too Long
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_mgmt_invalid_object:
summary: Invalid Object
value:
_errors:
- code: E003
message: Invalid Object
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_mgmt_malformed_command:
summary: Malformed Command
value:
_errors:
- code: E003
message: Malformed Command
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_504_panui_mgmt_session_timeout:
summary: Session Timeout
value:
_errors:
- code: '4'
message: Session Timeout
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_401_panui_auth_need_password_change:
summary: Need Password Change
value:
_errors:
- code: E016
message: The password needs to be changed.
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
json_400_panui_mgmt_bad_xpath:
summary: Bad XPath
value:
_errors:
- code: E013
message: Bad XPath
details: {}
_request_id: 123e4567-e89b-12d3-a456-426655440000
parameters:
uuid:
name: id
in: path
description: The UUID of the configuration resource
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
limit:
name: limit
in: query
description: The maximum number of results per page
required: false
schema:
type: integer
default: 200
folder:
name: folder
in: query
description: 'The folder in which the resource is defined
'
required: false
schema:
type: string
snippet:
name: snippet
in: query
description: 'The snippet in which the resource is defined
'
required: false
schema:
type: string
offset:
name: offset
in: query
description: The offset into the list of results returned
required: false
schema:
type: integer
default: 0
device:
name: device
in: query
description: 'The device in which the resource is defined
'
required: false
schema:
type: string
responses:
http_ok:
description: OK
not_found:
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/generic_error'
examples:
object_not_present:
$ref: '#/components/examples/json_404_panui_mgmt_object_not_present'
default_errors:
description: General Errors
content:
application/json:
schema:
$ref: '#/components/schemas/generic_error'
examples:
version_not_supported:
$ref: '#/components/examples/json_501_panui_restapi_version_not_supported'
method_not_allowed:
$ref: '#/components/examples/json_501_panui_restapi_method_not_supported'
action_not_supported:
$ref: '#/components/examples/json_405_panui_restapi_action_not_supported'
bad_xpath:
$ref: '#/components/examples/json_400_panui_mgmt_bad_xpath'
invalid_command:
$ref: '#/components/examples/json_400_panui_mgmt_invalid_command'
malformed_command:
$ref: '#/components/examples/json_400_panui_mgmt_malformed_command'
session_timeout:
$ref: '#/components/examples/json_504_panui_mgmt_session_timeout'
bad_request_errors_basic_with_body:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/generic_error'
examples:
input_format_mismatch:
$ref: '#/components/examples/json_400_panui_restapi_input_format_mismatch'
output_format_mismatch:
$ref: '#/components/examples/json_400_panui_restapi_output_format_mismatch'
missing_query_parameter:
$ref: '#/components/examples/json_400_panui_restapi_missing_query_parameter'
invalid_query_parameter:
$ref: '#/components/examples/json_400_panui_restapi_invalid_query_parameter'
missing_body:
$ref: '#/components/examples/json_400_panui_restapi_missing_body'
invalid_object:
$ref: '#/components/examples/json_400_panui_mgmt_invalid_object'
bad_request_errors_basic:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/generic_error'
examples:
input_format_mismatch:
$ref: '#/components/examples/json_400_panui_restapi_input_format_mismatch'
output_format_mismatch:
$ref: '#/components/examples/json_400_panui_restapi_output_format_mismatch'
missing_query_parameter:
$ref: '#/components/examples/json_400_panui_restapi_missing_query_parameter'
invalid_query_parameter:
$ref: '#/components/examples/json_400_panui_restapi_invalid_query_parameter'
auth_errors:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/generic_error'
examples:
auth_not_authenticated:
$ref: '#/components/examples/json_401_panui_auth_not_authenticated'
invalid_credential:
$ref: '#/components/examples/json_401_panui_auth_invalid_credential'
key_too_long:
$ref: '#/components/examples/json_401_panui_auth_key_too_long'
key_expired:
$ref: '#/components/examples/json_401_panui_auth_key_expired'
need_password_change:
$ref: '#/components/examples/json_401_panui_auth_need_password_change'
conflict_errors:
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/generic_error'
examples:
object_not_unique:
$ref: '#/components/examples/json_409_panui_mgmt_object_not_unique'
name_not_unique:
$ref: '#/components/examples/json_409_panui_mgmt_name_not_unique'
reference_not_zero:
$ref: '#/components/examples/json_409_panui_mgmt_reference_not_zero'
access_errors:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/generic_error'
examples:
auth_unauthorized:
$ref: '#/components/examples/json_403_panui_auth_unauthorized'
schemas:
generic_error:
type: object
properties:
_errors:
$ref: '#/components/schemas/error_detail_cause_infos'
_request_id:
type: string
x-examples: {}
error_detail_cause_info:
type: object
title: Cause Info
properties:
code:
type: string
message:
type: string
details:
oneOf:
- type: string
- type: object
help:
type: string
vulnerability-protection-signatures:
type: object
properties:
id:
type: string
description: UUID of the resource
readOnly: true
example: 123e4567-e89b-12d3-a456-426655440000
threat_id:
type: string
description: threat id range <41000-45000> and <6800001-6900000>
affected_host:
type: object
oneOf:
- type: object
title: client
properties:
client:
type: boolean
- type: object
title: server
properties:
server:
type: boolean
bugtraq:
type: array
items:
type: string
comment:
type: string
maxLength: 256
cve:
type: array
items:
type: string
default_action:
type: object
oneOf:
- type: object
title: allow
properties:
allow:
type: object
- type: object
title: alert
properties:
alert:
type: object
- type: object
title: drop
properties:
drop:
type: object
- type: object
title: reset_client
properties:
reset_client:
type: object
- type: object
title: reset_server
properties:
reset_server:
type: object
- type: object
title: reset_both
properties:
reset_both:
type: object
- type: object
title: block_ip
properties:
block_ip:
description: vulnerability protection bugtraq block ip
type: object
properties:
track_by:
enum:
- source-and-destination
- source
duration:
type: integer
minimum: 1
maximum: 3600
direction:
enum:
- client2server
- server2client
- both
reference:
type: array
items:
type: string
severity:
enum:
- critical
- low
- high
- medium
- informational
signature:
description: vulnerability protection signature
type: object
oneOf:
- type: object
title: combination
description: vulnerability protection signature combination
properties:
combination:
type: object
description: vulnerability protection signature combination object
properties:
and_condition:
type: array
description: vulnerability protection signature combination object and condition
items:
type: object
description: vulnerability protection signature combination object and condition object
properties:
name:
type: string
or_condition:
type: array
description: vulnerability protection signature combination object and condition object or condition
items:
type: object
description: vulnerability protection signature combination object and condition object or condition object
properties:
name:
type: string
threat_id:
type: string
order_free:
type: boolean
default: false
time_attribute:
type: object
properties:
interval:
type: integer
minimum: 1
maximum: 3600
threshold:
type: integer
minimum: 1
maximum: 255
track_by:
enum:
- source-and-destination
- source
- destination
- type: object
title: standard
description: vulnerability protection signature standard
properties:
standard:
type: array
description: vulnerability protection signature standard array
items:
type: object
description: vulnerability protection signature standard object
properties:
name:
type: string
and_condition:
type: array
description: vulnerability protection signature standard object and condition
items:
type: object
description: vulnerability protection signature standard object and condition object
properties:
name:
type: string
or_condition:
type: array
description: vulnerability protection signature standard object and condition object or condition
items:
type: object
description: vulnerability protection signature standard object and condition object or condition object
properties:
name:
type: string
operator:
type: object
description: vulnerability protection signature standard object and condition object or condition object operators
properties:
equal_to:
type: object
description: vulnerability protection signature standard object and condition object or condition object operators equal_to
properties:
context:
type: string
negate:
type: boolean
default: false
qualifier:
type: array
description: vulnerability protection signature standard object and condition object or condition object operators equal_to qualifier array
items:
type: object
description: vulnerability protection signature standard object and condition object or condition object operators equal_to qualifier array object
properties:
name:
type: string
value:
type: string
value:
type: integer
minimum: 0
maximum: 4294967295
greater_than:
type: object
description: vulnerability protection signature standard object and condition object or condition object operators greater_than
properties:
context:
type: string
qualifier:
type: array
description: vulnerability protection signature standard object and condition object or condition object operators greater_than qualifier
items:
type: object
description: vulnerability protection signature standard object and condition object or condition object operators greater_than qualifier object
properties:
name:
type: string
value:
type: string
value:
type: integer
minimum: 0
maximum: 4294967295
less_than:
type: object
description: vulnerability protection signature standard object and condition object or condition object operators less_than
properties:
context:
type: string
qualifier:
type: array
description: vulnerability protection signature standard object and condition object or condition object operators less_than array
items:
type: object
description: vulnerability protection signature standard object and condition object or condition object operators less_than array object
properties:
name:
type: string
value:
type: string
value:
type: integer
minimum: 0
maximum: 4294967295
pattern_match:
type: object
description: vulnerability protection signature standard object and condition object or condition object operators pattern match
properties:
context:
type: string
negate:
type: boolean
default: false
pattern:
type: string
qualifier:
type: array
description: vulnerability protection signature standard object and condition object or condition object operators pattern match qualifier
items:
type: object
description: vulnerability protection signature standard object and condition object or condition object operators pattern match qualifier object
properties:
name:
type: string
value:
type: string
comment:
type: string
maxLength: 256
order_free:
type: boolean
default: false
scope:
enum:
- protocol-data-unit
- session
required:
- name
threatname:
type: string
maxLength: 1024
vendor:
type: array
items:
type: string
required:
- threat_id
- threatname
- affected_host
- severity
- direction
- signature
oneOf:
- type: object
title: folder
properties:
folder:
type: string
pattern: ^[a-zA-Z\d\-_\. ]+$
maxLength: 64
description: The folder in which the resource is defined
example: My Folder
required:
- folder
- type: object
title: snippet
properties:
snippet:
type: string
pattern: ^[a-zA-Z\d\-_\. ]+$
maxLength: 64
description: The snippet in which the resource is defined
example: My Snippet
required:
- snippet
- type: object
title: device
properties:
device:
type: string
pattern: ^[a-zA-Z\d\-_\. ]+$
maxLength: 64
description: The device in which the resource is defined
example: My Device
required:
- device
error_detail_cause_infos:
type: array
items:
$ref: '#/components/schemas/error_detail_cause_info'
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-vulnerability-protection-signatures-api-openapi.yml