Palo Alto Networks HIP Objects API
The HIPObjects API from Palo Alto Networks — 2 operation(s) for hipobjects.
OpenAPI Specification
openapi: 3.2.0
info:
contact: {}
description: 'Manages [HIP objects](https://docs.paloaltonetworks.com/network-security/security-policy/objects/hip-objects).
'
title: HIP Object Management HIP Objects API
version: '1.0'
x-logo:
url: pan-logo.png
servers:
- url: https://api.sase.paloaltonetworks.com
tags:
- name: HIPObjects
paths:
/sse/config/v1/hip-objects:
get:
description: 'Get Hip objects.
'
operationId: get-sse-config-v1-hip-objects
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-hip-objects'
type: array
limit:
default: 200
type: number
offset:
default: 0
type: number
total:
type: number
type: object
description: List of hip objects
'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 hip objects
tags:
- HIPObjects
post:
description: 'Create a hip object.
'
operationId: post-sse-config-v1-hip-objects
parameters:
- $ref: '#/components/parameters/folder'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/objects-hip-objects'
description: The hip object 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 a hip object
tags:
- HIPObjects
/sse/config/v1/hip-objects/{id}:
delete:
description: 'Delete a hip object.
'
operationId: delete-sse-config-v1-hip-objects-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 a hip object
tags:
- HIPObjects
get:
description: 'Get a [HIP object](https://docs.paloaltonetworks.com/network-security/security-policy/objects/hip-objects) by ID.
'
operationId: get-sse-config-v1-hip-objects-id
parameters:
- $ref: '#/components/parameters/uuid-required'
responses:
'200':
content:
application/json:
schema:
allOf:
- items:
$ref: '#/components/schemas/objects-hip-objects'
type: array
description: Get the hip object 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 a HIP object by ID
tags:
- HIPObjects
put:
description: 'Modify a hip object.
'
operationId: put-sse-config-v1-hip-objects-id
parameters:
- $ref: '#/components/parameters/uuid-required'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/objects-hip-objects'
description: The hip object 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 a hip object
tags:
- HIPObjects
components:
examples:
json_401_panui_auth_key_expired:
summary: Key Expired
value:
_errors:
- code: E016
details: {}
message: Key Expired
_request_id: abcd-1234
json_501_panui_restapi_method_not_supported:
summary: Method Not Supported
value:
_errors:
- code: E012
details: {}
message: Method Not Supported
_request_id: abcd-1234
json_400_panui_restapi_input_format_mismatch:
summary: Input Format Mismatch
value:
_errors:
- code: E003
details: {}
message: 'Input Format Mismatch: input-format=json'
_request_id: abcd-1234
json_501_panui_restapi_version_not_supported:
summary: Version Not Supported
value:
_errors:
- code: E012
details: {}
message: Version Not Supported
_request_id: abcd-1234
json_409_panui_mgmt_name_not_unique:
summary: Name Not Unique
value:
_errors:
- code: E006
details: {}
message: Name Not Unique
_request_id: abcd-1234
json_409_panui_mgmt_object_not_unique:
summary: Object Not Unique
value:
_errors:
- code: E016
details: {}
message: Object Not Unique
_request_id: abcd-1234
json_404_panui_mgmt_object_not_present:
summary: Object Not Present
value:
_errors:
- code: E005
details: {}
message: Object Not Present
_request_id: abcd-1234
json_400_panui_restapi_missing_body:
summary: Missing Body
value:
_errors:
- code: E003
details: {}
message: Missing Body
_request_id: abcd-1234
json_409_panui_mgmt_reference_not_zero:
summary: Reference Not Zero
value:
_errors:
- code: E009
details: {}
message: Reference Not Zero
_request_id: abcd-1234
json_400_panui_mgmt_invalid_command:
summary: Invalid Command
value:
_errors:
- code: E003
details: {}
message: Invalid Command
_request_id: abcd-1234
json_400_panui_restapi_output_format_mismatch:
summary: Output Format Mismatch
value:
_errors:
- code: E003
details: {}
message: 'Output Format Mismatch: output-format=json Accept=xml'
_request_id: abcd-1234
json_401_panui_auth_not_authenticated:
summary: Not Authenticated
value:
_errors:
- code: E016
details: {}
message: Not Authenticated
_request_id: abcd-1234
json_401_panui_auth_invalid_credential:
summary: Invalid Credential
value:
_errors:
- code: E016
details: {}
message: Invalid Credential
_request_id: abcd-1234
json_403_panui_auth_unauthorized:
summary: Unauthorized
value:
_errors:
- code: E007
details: {}
message: Unauthorized
_request_id: abcd-1234
json_400_panui_restapi_missing_query_parameter:
summary: Missing Query Parameter
value:
_errors:
- code: E003
details: {}
message: 'Missing Query Parameter: name'
_request_id: abcd-1234
json_405_panui_restapi_action_not_supported:
summary: Action Not Supported
value:
_errors:
- code: E012
details: {}
message: 'Action Not Supported: move'
_request_id: abcd-1234
json_400_panui_restapi_invalid_query_parameter:
summary: Invalid Query Parameter
value:
_errors:
- code: E003
details: {}
message: 'Invalid Query Parameter: location=invalid'
_request_id: abcd-1234
json_401_panui_auth_key_too_long:
summary: Key Too Long
value:
_errors:
- code: E016
details: {}
message: Key Too Long
_request_id: abcd-1234
json_400_panui_mgmt_invalid_object:
summary: Invalid Object
value:
_errors:
- code: E003
details: {}
message: Invalid Object
_request_id: abcd-1234
json_400_panui_mgmt_malformed_command:
summary: Malformed Command
value:
_errors:
- code: E003
details: {}
message: Malformed Command
_request_id: abcd-1234
json_504_panui_mgmt_session_timeout:
summary: Session Timeout
value:
_errors:
- code: 4
details: {}
message: Session Timeout
_request_id: abcd-1234
json_401_panui_auth_need_password_change:
summary: Need Password Change
value:
_errors:
- code: E016
details: {}
message: The password needs to be changed.
_request_id: abcd-1234
json_400_panui_mgmt_bad_xpath:
summary: Bad XPath
value:
_errors:
- code: E013
details: {}
message: Bad XPath
_request_id: abcd-1234
responses:
http_ok:
description: Ok
not_found:
content:
application/json:
examples:
object_not_present:
$ref: '#/components/examples/json_404_panui_mgmt_object_not_present'
schema:
$ref: '#/components/schemas/generic_error'
description: Not Found
default_errors:
content:
application/json:
examples:
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'
method_not_allowed:
$ref: '#/components/examples/json_501_panui_restapi_method_not_supported'
session_timeout:
$ref: '#/components/examples/json_504_panui_mgmt_session_timeout'
version_not_supported:
$ref: '#/components/examples/json_501_panui_restapi_version_not_supported'
schema:
$ref: '#/components/schemas/generic_error'
description: General Errors
bad_request_errors_basic_with_body:
content:
application/json:
examples:
input_format_mismatch:
$ref: '#/components/examples/json_400_panui_restapi_input_format_mismatch'
invalid_object:
$ref: '#/components/examples/json_400_panui_mgmt_invalid_object'
invalid_query_parameter:
$ref: '#/components/examples/json_400_panui_restapi_invalid_query_parameter'
missing_body:
$ref: '#/components/examples/json_400_panui_restapi_missing_body'
missing_query_parameter:
$ref: '#/components/examples/json_400_panui_restapi_missing_query_parameter'
output_format_mismatch:
$ref: '#/components/examples/json_400_panui_restapi_output_format_mismatch'
schema:
$ref: '#/components/schemas/generic_error'
description: Bad Request
bad_request_errors_basic:
content:
application/json:
examples:
input_format_mismatch:
$ref: '#/components/examples/json_400_panui_restapi_input_format_mismatch'
invalid_query_parameter:
$ref: '#/components/examples/json_400_panui_restapi_invalid_query_parameter'
missing_query_parameter:
$ref: '#/components/examples/json_400_panui_restapi_missing_query_parameter'
output_format_mismatch:
$ref: '#/components/examples/json_400_panui_restapi_output_format_mismatch'
schema:
$ref: '#/components/schemas/generic_error'
description: Bad Request
auth_errors:
content:
application/json:
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_expired:
$ref: '#/components/examples/json_401_panui_auth_key_expired'
key_too_long:
$ref: '#/components/examples/json_401_panui_auth_key_too_long'
need_password_change:
$ref: '#/components/examples/json_401_panui_auth_need_password_change'
schema:
$ref: '#/components/schemas/generic_error'
description: Unauthorized
http_created:
description: Created
conflict_errors:
content:
application/json:
examples:
name_not_unique:
$ref: '#/components/examples/json_409_panui_mgmt_name_not_unique'
object_not_unique:
$ref: '#/components/examples/json_409_panui_mgmt_object_not_unique'
reference_not_zero:
$ref: '#/components/examples/json_409_panui_mgmt_reference_not_zero'
schema:
$ref: '#/components/schemas/generic_error'
description: Conflict
access_errors:
content:
application/json:
examples:
auth_unauthorized:
$ref: '#/components/examples/json_403_panui_auth_unauthorized'
schema:
$ref: '#/components/schemas/generic_error'
description: Forbidden
parameters:
uuid-required:
description: 'The resource''s unique identifier.
'
in: path
name: id
required: true
schema:
type: string
offset-optional:
description: 'The offset of the result entry.
'
in: query
name: offset
required: false
schema:
type: number
limit-optional:
description: 'The maximum number of result objects to return per page.
'
in: query
name: limit
required: false
schema:
type: number
folder:
description: 'The folder on which you want to perform this operation.
'
in: query
name: folder
required: true
schema:
enum:
- Shared
- Mobile Users
- Remote Networks
- Service Connections
- Mobile Users Container
- Mobile Users Explicit Proxy
pattern: ^[0-9a-zA-Z._-\s]{1,}$
type: string
name-optional:
description: 'The name of the entry.
'
in: query
name: name
required: false
schema:
type: string
schemas:
generic_error:
properties:
_errors:
$ref: '#/components/schemas/error_detail_cause_infos'
_request_id:
type: string
type: object
error_detail_cause_info:
properties:
code:
type: string
details:
type: object
help:
type: string
message:
type: string
title: Cause Info
type: object
objects-hip-objects:
properties:
anti_malware:
properties:
criteria:
properties:
is_installed:
default: true
description: Is Installed
type: boolean
last_scan_time:
oneOf:
- properties:
not_available:
type: object
required:
- not_available
title: not_available
- properties:
within:
oneOf:
- properties:
days:
default: 1
description: specify time in days
maximum: 65535
minimum: 1
type: integer
title: days
- properties:
hours:
default: 24
description: specify time in hours
maximum: 65535
minimum: 1
type: integer
title: hours
type: object
required:
- within
title: within
- properties:
not_within:
oneOf:
- properties:
days:
default: 1
description: specify time in days
maximum: 65535
minimum: 1
type: integer
title: days
- properties:
hours:
default: 24
description: specify time in hours
maximum: 65535
minimum: 1
type: integer
title: hours
type: object
required:
- not_within
title: not_within
type: object
product_version:
oneOf:
- properties:
greater_equal:
maxLength: 255
minLength: 0
type: string
required:
- greater_equal
title: greater_equal
- properties:
greater_than:
maxLength: 255
minLength: 0
type: string
required:
- greater_than
title: greater_than
- properties:
is:
maxLength: 255
minLength: 0
type: string
required:
- is
title: is
- properties:
is_not:
maxLength: 255
minLength: 0
type: string
required:
- is_not
title: is_not
- properties:
less_equal:
maxLength: 255
minLength: 0
type: string
required:
- less_equal
title: less_equal
- properties:
less_than:
maxLength: 255
minLength: 0
type: string
required:
- less_than
title: less_than
- properties:
contains:
maxLength: 255
minLength: 0
type: string
required:
- contains
title: contains
- properties:
within:
properties:
versions:
default: 1
description: versions range
maximum: 65535
minimum: 1
type: integer
required:
- versions
type: object
required:
- within
title: within
- properties:
not_within:
properties:
versions:
default: 1
description: versions range
maximum: 65535
minimum: 1
type: integer
required:
- versions
type: object
required:
- not_within
title: not_within
type: object
real_time_protection:
description: real time protection
enum:
- 'no'
- 'yes'
- not-available
type: string
virdef_version:
oneOf:
- properties:
within:
oneOf:
- properties:
days:
default: 1
description: specify time in days
maximum: 65535
minimum: 1
type: integer
title: days
- properties:
versions:
default: 1
description: specify versions range
maximum: 65535
minimum: 1
type: integer
title: versions
type: object
required:
- within
title: within
- properties:
not_within:
oneOf:
- properties:
days:
default: 1
description: specify time in days
maximum: 65535
minimum: 1
type: integer
title: days
- properties:
versions:
default: 1
description: specify versions range
maximum: 65535
minimum: 1
type: integer
title: versions
type: object
required:
- not_within
title: not_within
type: object
type: object
exclude_vendor:
default: false
type: boolean
vendor:
description: Vendor name
items:
description: Product name
properties:
name:
maxLength: 103
type: string
product:
items:
maxLength: 1023
pattern: .*
type: string
type: array
required:
- name
type: object
type: array
type: object
certificate:
properties:
criteria:
properties:
certificate_attributes:
items:
properties:
name:
description: Attribute Name
type: string
value:
description: Key value
maxLength: 1024
pattern: .*
type: string
required:
- name
type: object
type: array
certificate_profile:
description: Profile for authenticating client certificates
type: string
x-panMemberOf:
- location: shared
schema: certificate-profile
subPath: name
type: object
type: object
custom_checks:
properties:
criteria:
properties:
plist:
items:
properties:
key:
items:
properties:
name:
description: Key name
maxLength: 1023
type: string
negate:
default: false
description: Value does not exist or match specified value data
type: boolean
value:
description: Key value
maxLength: 1024
pattern: .*
type: string
required:
- name
type: object
type: array
name:
description: Preference list
maxLength: 1023
type: string
negate:
default: false
description: Plist does not exist
type: boolean
required:
- name
type: object
type: array
process_list:
items:
properties:
name:
description: Process Name
maxLength: 1023
type: string
running:
default: true
type: boolean
required:
- name
type: object
type: array
registry_key:
items:
properties:
default_value_data:
description: Registry key default value data
maxLength: 1024
pattern: .*
type: string
name:
description: Registry key
maxLength: 1023
type: string
negate:
default: false
description: Key does not exist or match specified value data
type: boolean
registry_value:
items:
properties:
name:
description: Registry value name
maxLength: 1023
type: string
negate:
default: false
description: Value does not exist or match specified value data
type: boolean
value_data:
description: Registry value data
maxLength: 1024
pattern: .*
type: string
required:
- name
type: object
type: array
required:
- name
type: object
type: array
type: object
required:
- criteria
type: object
data_loss_prevention:
properties:
criteria:
properties:
is_enabled:
description: is enabled
enum:
- 'no'
- 'yes'
- not-available
type: string
is_installed:
default: true
description: Is Installed
type: boolean
type: object
exclude_vendor:
default: false
type: boolean
vendor:
description: Vendor name
items:
properties:
name:
maxLength: 103
type: string
product:
description: Product name
items:
maxLength: 1023
pattern: .*
type: string
type: array
required:
- name
type: object
type: array
type: object
description:
maxLength: 255
minLength: 0
type: string
disk_backup:
properties:
criteria:
properties:
is_installed:
default: true
description: Is Installed
type: boolean
last_backup_time:
oneOf:
- properties:
not_available:
type: object
required:
- not_available
title: not_available
- properties:
within:
oneOf:
- properties:
days:
default: 1
description: specify time in days
maximum: 65535
minimum: 1
type: integer
title: days
- properties:
hours:
default: 24
description: specify time in hours
maximum: 65535
minimum: 1
type: integer
title: hours
type: object
required:
- within
title: within
- properties:
not_within:
oneOf:
- properties:
days:
# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-hipobjects-api-openapi.yml