List hip objects
Get Hip objects.
Query Parameters
The maximum number of result objects to return per page.
The offset of the result entry.
The name of the entry.
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.
- 200
- 400
- 401
- 403
- 404
- default
List of hip objects
Schema
- Array [
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- ]
data object[]
anti_malware object
criteria object
Default value: true
Is Installed
last_scan_time object
within object required
Possible values: >= 1
and <= 65535
Default value: 1
specify time in days
Possible values: >= 1
and <= 65535
Default value: 24
specify time in hours
not_within object required
Possible values: >= 1
and <= 65535
Default value: 1
specify time in days
Possible values: >= 1
and <= 65535
Default value: 24
specify time in hours
product_version object
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
within object required
Possible values: >= 1
and <= 65535
Default value: 1
versions range
not_within object required
Possible values: >= 1
and <= 65535
Default value: 1
versions range
Possible values: [no
, yes
, not-available
]
real time protection
virdef_version object
within object required
Possible values: >= 1
and <= 65535
Default value: 1
specify time in days
Possible values: >= 1
and <= 65535
Default value: 1
specify versions range
not_within object required
Possible values: >= 1
and <= 65535
Default value: 1
specify time in days
Possible values: >= 1
and <= 65535
Default value: 1
specify versions range
Default value: false
vendor object[]
Vendor name
Possible values: <= 103 characters
Possible values: <= 1023 characters
, Value must match regular expression .*
certificate object
criteria object
certificate_attributes object[]
Attribute Name
Possible values: <= 1024 characters
, Value must match regular expression .*
Key value
Profile for authenticating client certificates
custom_checks object
criteria object required
plist object[]
key object[]
Possible values: <= 1023 characters
Key name
Default value: false
Value does not exist or match specified value data
Possible values: <= 1024 characters
, Value must match regular expression .*
Key value
Possible values: <= 1023 characters
Preference list
Default value: false
Plist does not exist
process_list object[]
Possible values: <= 1023 characters
Process Name
Default value: true
registry_key object[]
Possible values: <= 1024 characters
, Value must match regular expression .*
Registry key default value data
Possible values: <= 1023 characters
Registry key
Default value: false
Key does not exist or match specified value data
registry_value object[]
Possible values: <= 1023 characters
Registry value name
Default value: false
Value does not exist or match specified value data
Possible values: <= 1024 characters
, Value must match regular expression .*
Registry value data
data_loss_prevention object
criteria object
Possible values: [no
, yes
, not-available
]
is enabled
Default value: true
Is Installed
Default value: false
vendor object[]
Vendor name
Possible values: <= 103 characters
Possible values: <= 1023 characters
, Value must match regular expression .*
Product name
Possible values: <= 255 characters
disk_backup object
criteria object
Default value: true
Is Installed
last_backup_time object
within object required
Possible values: >= 1
and <= 65535
Default value: 1
specify time in days
Possible values: >= 1
and <= 65535
Default value: 24
specify time in hours
not_within object required
Possible values: >= 1
and <= 65535
Default value: 1
specify time in days
Possible values: >= 1
and <= 65535
Default value: 24
specify time in hours
Default value: false
vendor object[]
Vendor name
Possible values: <= 103 characters
Possible values: <= 1023 characters
, Value must match regular expression .*
disk_encryption object
criteria object
Encryption locations
encrypted_locations object[]
encryption_state object
Possible values: [encrypted
, unencrypted
, partial
, unknown
]
Default value: encrypted
Possible values: [encrypted
, unencrypted
, partial
, unknown
]
Default value: encrypted
Possible values: <= 1023 characters
Encryption location
Default value: true
Is Installed
Default value: false
vendor object[]
Vendor name
Possible values: <= 103 characters
Possible values: <= 1023 characters
, Value must match regular expression .*
firewall object
criteria object
Possible values: [no
, yes
, not-available
]
is enabled
Default value: true
Is Installed
Default value: false
vendor object[]
Vendor name
Possible values: <= 103 characters
Possible values: <= 1023 characters
, Value must match regular expression .*
host_info object
criteria object required
client_version object
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
domain object
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
host_id object
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
host_name object
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
If device is managed
os object
contains object required
Possible values: <= 255 characters
Default value: All
Microsoft vendor
Possible values: <= 255 characters
Default value: All
Apple vendor
Possible values: <= 255 characters
Default value: All
Google vendor
Possible values: <= 255 characters
Default value: All
Linux vendor
Possible values: <= 255 characters
Other vendor
serial_number object
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
mobile_device object
criteria object
applications object
has_malware object
yes object
excludes object[]
Possible values: <= 1024 characters
, Value must match regular expression .*
application hash
Possible values: <= 31 characters
Possible values: <= 1024 characters
, Value must match regular expression .*
application package name
Has apps that are not managed
includes object[]
Possible values: <= 1024 characters
, Value must match regular expression .*
application hash
Possible values: <= 31 characters
Possible values: <= 1024 characters
, Value must match regular expression .*
application package name
If device's disk is encrypted
imei object
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
If device is by rooted/jailbroken
last_checkin_time object
within object required
Possible values: >= 1
and <= 365
Default value: 30
specify time in days
not_within object required
Possible values: >= 1
and <= 365
Default value: 30
specify time in days
model object
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
If device's passcode is present
phone_number object
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
tag object
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 255 characters
Possible values: <= 31 characters
Alphanumeric string [ 0-9a-zA-Z._-]
network_info object
criteria object
network object
is object
wifi object
Possible values: <= 1023 characters
, Value must match regular expression .*
SSID
mobile object
Possible values: <= 1023 characters
, Value must match regular expression .*
is_not object
wifi object
Possible values: <= 1023 characters
, Value must match regular expression .*
SSID
mobile object
Possible values: <= 1023 characters
, Value must match regular expression .*
patch_management object
criteria object
Possible values: [no
, yes
, not-available
]
is enabled
Default value: yes
Is Installed
missing_patches object
Possible values: [has-any
, has-none
, has-all
]
Default value: has-any
Possible values: <= 1023 characters
, Value must match regular expression .*
severity object
Possible values: <= 100000
Possible values: <= 100000
Possible values: <= 100000
Possible values: <= 100000
Possible values: <= 100000
Possible values: <= 100000
Default value: no
vendor object[]
Vendor name
Possible values: <= 103 characters
Possible values: <= 1023 characters
, Value must match regular expression .*
Product name
Default value: 200
Default value: 0
{
"data": [
{
"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"
}
}
},
"id": "abcd-1234",
"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"
]
}
]
}
}
],
"limit": 200,
"offset": 0,
"total": 0
}
Bad Request
Schema
- Array [
- ]
_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 Query Parameter
{
"_errors": [
{
"code": "E003",
"details": {},
"message": "Invalid Query Parameter: location=invalid"
}
],
"_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
Schema
- Array [
- ]
_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
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Unauthorized
{
"_errors": [
{
"code": "E007",
"details": {},
"message": "Unauthorized"
}
],
"_request_id": "abcd-1234"
}
Not Found
Schema
- Array [
- ]
_errors object[]
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Object Not Present
{
"_errors": [
{
"code": "E005",
"details": {},
"message": "Object Not Present"
}
],
"_request_id": "abcd-1234"
}
General Errors
Schema
- Array [
- ]
_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"
}