Create a hip object
POSThttps://api.sase.paloaltonetworks.com/sse/config/v1/hip-objects
Create a hip object.
Request
Query Parameters
Possible values: Value must match regular expression ^[0-9a-zA-Z._-\s]{1,}$
, [Shared
, Mobile Users
, Remote Networks
, Service Connections
, Mobile Users Container
, Mobile Users Explicit Proxy
]
The folder on which you want to perform this operation.
- application/json
Body
The hip object you want to create
anti_malware object
certificate object
custom_checks object
data_loss_prevention object
Possible values: <= 255 characters
disk_backup object
disk_encryption object
firewall object
host_info object
mobile_device object
Alphanumeric string [ 0-9a-zA-Z._-]
Possible values: <= 31 characters
network_info object
patch_management object
Responses
- 201
- 400
- 401
- 403
- 409
- default
Created
Bad Request
- application/json
- Schema
- Example (auto)
- input_format_mismatch
- invalid_object
- invalid_query_parameter
- missing_body
- missing_query_parameter
- output_format_mismatch
Schema
_errors object[]
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Input Format Mismatch
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Input Format Mismatch: input-format=json"
}
],
"_request_id": "abcd-1234"
}
Invalid Object
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Invalid Object"
}
],
"_request_id": "abcd-1234"
}
Invalid Query Parameter
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Invalid Query Parameter: location=invalid"
}
],
"_request_id": "abcd-1234"
}
Missing Body
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Missing Body"
}
],
"_request_id": "abcd-1234"
}
Missing Query Parameter
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Missing Query Parameter: name"
}
],
"_request_id": "abcd-1234"
}
Output Format Mismatch
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Output Format Mismatch: output-format=json Accept=xml"
}
],
"_request_id": "abcd-1234"
}
Unauthorized
- application/json
- Schema
- Example (auto)
- auth_not_authenticated
- invalid_credential
- key_expired
- key_too_long
- need_password_change
Schema
_errors object[]
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Not Authenticated
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Not Authenticated"
}
],
"_request_id": "abcd-1234"
}
Invalid Credential
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Invalid Credential"
}
],
"_request_id": "abcd-1234"
}
Key Expired
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Key Expired"
}
],
"_request_id": "abcd-1234"
}
Key Too Long
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Key Too Long"
}
],
"_request_id": "abcd-1234"
}
Need Password Change
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "The password needs to be changed."
}
],
"_request_id": "abcd-1234"
}
Forbidden
- application/json
- Schema
- Example (auto)
- auth_unauthorized
Schema
_errors object[]
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Unauthorized
{
"_errors": [
{
"code": "E007",
"details": {},
"message": "Unauthorized"
}
],
"_request_id": "abcd-1234"
}
Conflict
- application/json
- Schema
- Example (auto)
- name_not_unique
- object_not_unique
- reference_not_zero
Schema
_errors object[]
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Name Not Unique
{
"_errors": [
{
"code": "E006",
"details": {},
"message": "Name Not Unique"
}
],
"_request_id": "abcd-1234"
}
Object Not Unique
{
"_errors": [
{
"code": "E016",
"details": {},
"message": "Object Not Unique"
}
],
"_request_id": "abcd-1234"
}
Reference Not Zero
{
"_errors": [
{
"code": "E009",
"details": {},
"message": "Reference Not Zero"
}
],
"_request_id": "abcd-1234"
}
General Errors
- application/json
- Schema
- Example (auto)
- action_not_supported
- bad_xpath
- invalid_command
- malformed_command
- method_not_allowed
- session_timeout
- version_not_supported
Schema
_errors object[]
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Action Not Supported
{
"_errors": [
{
"code": "E012",
"details": {},
"message": "Action Not Supported: move"
}
],
"_request_id": "abcd-1234"
}
Bad XPath
{
"_errors": [
{
"code": "E013",
"details": {},
"message": "Bad XPath"
}
],
"_request_id": "abcd-1234"
}
Invalid Command
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Invalid Command"
}
],
"_request_id": "abcd-1234"
}
Malformed Command
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Malformed Command"
}
],
"_request_id": "abcd-1234"
}
Method Not Supported
{
"_errors": [
{
"code": "E012",
"details": {},
"message": "Method Not Supported"
}
],
"_request_id": "abcd-1234"
}
Session Timeout
{
"_errors": [
{
"code": 4,
"details": {},
"message": "Session Timeout"
}
],
"_request_id": "abcd-1234"
}
Version Not Supported
{
"_errors": [
{
"code": "E012",
"details": {},
"message": "Version Not Supported"
}
],
"_request_id": "abcd-1234"
}
Authorization: http
name: Bearertype: httpscheme: bearer
- curl
- python
- go
- nodejs
- csharp
- php
- CURL
curl -L 'https://api.sase.paloaltonetworks.com/sse/config/v1/hip-objects' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
"anti_malware": {
"criteria": {
"is_installed": true,
"last_scan_time": {
"not_available": {}
},
"product_version": {
"greater_equal": "string"
},
"real_time_protection": "no",
"virdef_version": {
"within": {
"days": 1
}
}
},
"exclude_vendor": false,
"vendor": [
{
"name": "string",
"product": [
"string"
]
}
]
},
"certificate": {
"criteria": {
"certificate_attributes": [
{
"name": "string",
"value": "string"
}
],
"certificate_profile": "string"
}
},
"custom_checks": {
"criteria": {
"plist": [
{
"key": [
{
"name": "string",
"negate": false,
"value": "string"
}
],
"name": "string",
"negate": false
}
],
"process_list": [
{
"name": "string",
"running": true
}
],
"registry_key": [
{
"default_value_data": "string",
"name": "string",
"negate": false,
"registry_value": [
{
"name": "string",
"negate": false,
"value_data": "string"
}
]
}
]
}
},
"data_loss_prevention": {
"criteria": {
"is_enabled": "no",
"is_installed": true
},
"exclude_vendor": false,
"vendor": [
{
"name": "string",
"product": [
"string"
]
}
]
},
"description": "string",
"disk_backup": {
"criteria": {
"is_installed": true,
"last_backup_time": {
"not_available": {}
}
},
"exclude_vendor": false,
"vendor": [
{
"name": "string",
"product": [
"string"
]
}
]
},
"disk_encryption": {
"criteria": {
"encrypted_locations": [
{
"encryption_state": {
"is": "encrypted"
},
"name": "string"
}
],
"is_installed": true
},
"exclude_vendor": false,
"vendor": [
{
"name": "string",
"product": [
"string"
]
}
]
},
"firewall": {
"criteria": {
"is_enabled": "no",
"is_installed": true
},
"exclude_vendor": false,
"vendor": [
{
"name": "string",
"product": [
"string"
]
}
]
},
"host_info": {
"criteria": {
"client_version": {
"contains": "string"
},
"domain": {
"contains": "string"
},
"host_id": {
"contains": "string"
},
"host_name": {
"contains": "string"
},
"managed": true,
"os": {
"contains": {
"Microsoft": "All"
}
},
"serial_number": {
"contains": "string"
}
}
},
"mobile_device": {
"criteria": {
"applications": {
"has_malware": {
"no": {}
},
"has_unmanaged_app": true,
"includes": [
{
"hash": "string",
"name": "string",
"package": "string"
}
]
},
"disk_encrypted": true,
"imei": {
"contains": "string"
},
"jailbroken": true,
"last_checkin_time": {
"within": {
"days": 30
}
},
"model": {
"contains": "string"
},
"passcode_set": true,
"phone_number": {
"contains": "string"
},
"tag": {
"contains": "string"
}
}
},
"name": "string",
"network_info": {
"criteria": {
"network": {
"is": {
"wifi": {
"ssid": "string"
}
}
}
}
},
"patch_management": {
"criteria": {
"is_enabled": "no",
"is_installed": "yes",
"missing_patches": {
"check": "has-any",
"patches": [
"string"
],
"severity": {
"greater_equal": 0
}
}
},
"exclude_vendor": "no",
"vendor": [
{
"name": "string",
"product": [
"string"
]
}
]
}
}'