Edit a hip object
Modify a hip object.
Path Parameters
- id string required
The resource's unique identifier.
- application/json
Request Body
The hip object you want to edit
anti_malware object
criteria object
is_installed booleanDefault value:
trueIs Installed
last_scan_time object
- oneOf
- not_available
- within
- not_within
not_available object requiredwithin object required
- oneOf
- days
- hours
days integerPossible values:
>= 1and<= 65535Default value:
1specify time in days
hours integerPossible values:
>= 1and<= 65535Default value:
24specify time in hours
not_within object required
- oneOf
- days
- hours
days integerPossible values:
>= 1and<= 65535Default value:
1specify time in days
hours integerPossible values:
>= 1and<= 65535Default value:
24specify time in hours
product_version object
- oneOf
- greater_equal
- greater_than
- is
- is_not
- less_equal
- less_than
- contains
- within
- not_within
greater_equal string requiredPossible values:
<= 255 charactersgreater_than string requiredPossible values:
<= 255 charactersis string requiredPossible values:
<= 255 charactersis_not string requiredPossible values:
<= 255 charactersless_equal string requiredPossible values:
<= 255 charactersless_than string requiredPossible values:
<= 255 characterscontains string requiredPossible values:
<= 255 characterswithin object required
versions integer requiredPossible values:
>= 1and<= 65535Default value:
1versions range
not_within object required
versions integer requiredPossible values:
>= 1and<= 65535Default value:
1versions range
real_time_protection stringPossible values: [
no,yes,not-available]real time protection
virdef_version object
- oneOf
- within
- not_within
within object required
- oneOf
- days
- versions
days integerPossible values:
>= 1and<= 65535Default value:
1specify time in days
versions integerPossible values:
>= 1and<= 65535Default value:
1specify versions range
not_within object required
- oneOf
- days
- versions
days integerPossible values:
>= 1and<= 65535Default value:
1specify time in days
versions integerPossible values:
>= 1and<= 65535Default value:
1specify versions range
exclude_vendor booleanDefault value:
falsevendor object[]
Vendor name
Array [name string requiredPossible values:
<= 103 charactersproduct string[]Possible values:
<= 1023 characters, Value must match regular expression.*]certificate object
criteria object
certificate_attributes object[]
Array [name string requiredAttribute Name
value stringPossible values:
<= 1024 characters, Value must match regular expression.*Key value
]certificate_profile stringProfile for authenticating client certificates
custom_checks object
criteria object required
plist object[]
Array [key object[]
Array [name string requiredPossible values:
<= 1023 charactersKey name
negate booleanDefault value:
falseValue does not exist or match specified value data
value stringPossible values:
<= 1024 characters, Value must match regular expression.*Key value
]name string requiredPossible values:
<= 1023 charactersPreference list
negate booleanDefault value:
falsePlist does not exist
]process_list object[]
Array [name string requiredPossible values:
<= 1023 charactersProcess Name
running booleanDefault value:
true]registry_key object[]
Array [default_value_data stringPossible values:
<= 1024 characters, Value must match regular expression.*Registry key default value data
name string requiredPossible values:
<= 1023 charactersRegistry key
negate booleanDefault value:
falseKey does not exist or match specified value data
registry_value object[]
Array [name string requiredPossible values:
<= 1023 charactersRegistry value name
negate booleanDefault value:
falseValue does not exist or match specified value data
value_data stringPossible values:
<= 1024 characters, Value must match regular expression.*Registry value data
]]data_loss_prevention object
criteria object
is_enabled stringPossible values: [
no,yes,not-available]is enabled
is_installed booleanDefault value:
trueIs Installed
exclude_vendor booleanDefault value:
falsevendor object[]
Vendor name
Array [name string requiredPossible values:
<= 103 charactersproduct string[]Possible values:
<= 1023 characters, Value must match regular expression.*Product name
]- description string
Possible values:
<= 255 characters disk_backup object
criteria object
is_installed booleanDefault value:
trueIs Installed
last_backup_time object
- oneOf
- not_available
- within
- not_within
not_available object requiredwithin object required
- oneOf
- days
- hours
days integerPossible values:
>= 1and<= 65535Default value:
1specify time in days
hours integerPossible values:
>= 1and<= 65535Default value:
24specify time in hours
not_within object required
- oneOf
- days
- hours
days integerPossible values:
>= 1and<= 65535Default value:
1specify time in days
hours integerPossible values:
>= 1and<= 65535Default value:
24specify time in hours
exclude_vendor booleanDefault value:
falsevendor object[]
Vendor name
Array [name string requiredPossible values:
<= 103 charactersproduct string[]Possible values:
<= 1023 characters, Value must match regular expression.*]disk_encryption object
criteria object
Encryption locations
encrypted_locations object[]
Array [encryption_state object
- oneOf
- is
- is_not
is stringPossible values: [
encrypted,unencrypted,partial,unknown]Default value:
encryptedis_not stringPossible values: [
encrypted,unencrypted,partial,unknown]Default value:
encryptedname string requiredPossible values:
<= 1023 charactersEncryption location
]is_installed booleanDefault value:
trueIs Installed
exclude_vendor booleanDefault value:
falsevendor object[]
Vendor name
Array [name string requiredPossible values:
<= 103 charactersproduct string[]Possible values:
<= 1023 characters, Value must match regular expression.*]firewall object
criteria object
is_enabled stringPossible values: [
no,yes,not-available]is enabled
is_installed booleanDefault value:
trueIs Installed
exclude_vendor booleanDefault value:
falsevendor object[]
Vendor name
Array [name string requiredPossible values:
<= 103 charactersproduct string[]Possible values:
<= 1023 characters, Value must match regular expression.*]host_info object
criteria object required
client_version object
- oneOf
- contains
- is
- is_not
contains string requiredPossible values:
<= 255 charactersis string requiredPossible values:
<= 255 charactersis_not string requiredPossible values:
<= 255 charactersdomain object
- oneOf
- contains
- is
- is_not
contains string requiredPossible values:
<= 255 charactersis string requiredPossible values:
<= 255 charactersis_not string requiredPossible values:
<= 255 charactershost_id object
- oneOf
- contains
- is
- is_not
contains string requiredPossible values:
<= 255 charactersis string requiredPossible values:
<= 255 charactersis_not string requiredPossible values:
<= 255 charactershost_name object
- oneOf
- contains
- is
- is_not
contains string requiredPossible values:
<= 255 charactersis string requiredPossible values:
<= 255 charactersis_not string requiredPossible values:
<= 255 charactersmanaged booleanIf device is managed
os object
- oneOf
- contains
contains object required
- oneOf
- Microsoft
- Apple
- Linux
- Other
Microsoft string requiredPossible values:
<= 255 charactersDefault value:
AllMicrosoft vendor
Apple string requiredPossible values:
<= 255 charactersDefault value:
AllApple vendor
Google string requiredPossible values:
<= 255 charactersDefault value:
AllGoogle vendor
Linux string requiredPossible values:
<= 255 charactersDefault value:
AllLinux vendor
Other string requiredPossible values:
<= 255 charactersOther vendor
serial_number object
- oneOf
- contains
- is
- is_not
contains string requiredPossible values:
<= 255 charactersis string requiredPossible values:
<= 255 charactersis_not string requiredPossible values:
<= 255 charactersmobile_device object
criteria object
applications object
has_malware object
- oneOf
- no
- yes
no objectyes object
excludes object[]
Array [hash stringPossible values:
<= 1024 characters, Value must match regular expression.*application hash
name string requiredPossible values:
<= 31 characterspackage stringPossible values:
<= 1024 characters, Value must match regular expression.*application package name
]has_unmanaged_app booleanHas apps that are not managed
includes object[]
Array [hash stringPossible values:
<= 1024 characters, Value must match regular expression.*application hash
name string requiredPossible values:
<= 31 characterspackage stringPossible values:
<= 1024 characters, Value must match regular expression.*application package name
]disk_encrypted booleanIf device's disk is encrypted
imei object
- oneOf
- contains
- is
- is_not
contains string requiredPossible values:
<= 255 charactersis string requiredPossible values:
<= 255 charactersis_not string requiredPossible values:
<= 255 charactersjailbroken booleanIf device is by rooted/jailbroken
last_checkin_time object
- oneOf
- within
- not_within
within object required
days integer requiredPossible values:
>= 1and<= 365Default value:
30specify time in days
not_within object required
days integer requiredPossible values:
>= 1and<= 365Default value:
30specify time in days
model object
- oneOf
- contains
- is
- is_not
contains string requiredPossible values:
<= 255 charactersis string requiredPossible values:
<= 255 charactersis_not string requiredPossible values:
<= 255 characterspasscode_set booleanIf device's passcode is present
phone_number object
- oneOf
- contains
- is
- is_not
contains string requiredPossible values:
<= 255 charactersis string requiredPossible values:
<= 255 charactersis_not string requiredPossible values:
<= 255 characterstag object
- oneOf
- contains
- is
- is_not
contains string requiredPossible values:
<= 255 charactersis string requiredPossible values:
<= 255 charactersis_not string requiredPossible values:
<= 255 characters- name string required
Possible values:
<= 31 charactersAlphanumeric string [ 0-9a-zA-Z._-]
network_info object
criteria object
network object
- oneOf
- is
- is_not
is object
- oneOf
- wifi
- mobile
- unknown
wifi object
ssid stringPossible values:
<= 1023 characters, Value must match regular expression.*SSID
mobile object
carrier stringPossible values:
<= 1023 characters, Value must match regular expression.*unknown objectis_not object
- oneOf
- wifi
- mobile
- ethernet
- unknown
wifi object
ssid stringPossible values:
<= 1023 characters, Value must match regular expression.*SSID
mobile object
carrier stringPossible values:
<= 1023 characters, Value must match regular expression.*ethernet objectunknown objectpatch_management object
criteria object
is_enabled stringPossible values: [
no,yes,not-available]is enabled
is_installed booleanDefault value:
yesIs Installed
missing_patches object
check string requiredPossible values: [
has-any,has-none,has-all]Default value:
has-anypatches string[]Possible values:
<= 1023 characters, Value must match regular expression.*severity object
- oneOf
- greater_equal
- greater_than
- is
- is_not
- less_equal
- less_than
greater_equal integer requiredPossible values:
<= 100000greater_than integer requiredPossible values:
<= 100000is integer requiredPossible values:
<= 100000is_not integer requiredPossible values:
<= 100000less_equal integer requiredPossible values:
<= 100000less_than integer requiredPossible values:
<= 100000exclude_vendor booleanDefault value:
novendor object[]
Vendor name
Array [name string requiredPossible values:
<= 103 charactersproduct string[]Possible values:
<= 1023 characters, Value must match regular expression.*Product name
]
- 200
- 400
- 401
- 403
- 404
- 409
- default
Ok
Bad Request
- application/json
- Schema
- Example (from schema)
- input_format_mismatch
- invalid_object
- invalid_query_parameter
- missing_body
- missing_query_parameter
- output_format_mismatch
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_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 (from schema)
- auth_not_authenticated
- invalid_credential
- key_expired
- key_too_long
- need_password_change
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_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 (from schema)
- auth_unauthorized
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_errors": [
{
"code": "string",
"details": {},
"help": "string",
"message": "string"
}
],
"_request_id": "string"
}
Unauthorized
{
"_errors": [
{
"code": "E007",
"details": {},
"message": "Unauthorized"
}
],
"_request_id": "abcd-1234"
}
Not Found
- application/json
- Schema
- Example (from schema)
- object_not_present
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_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"
}
Conflict
- application/json
- Schema
- Example (from schema)
- name_not_unique
- object_not_unique
- reference_not_zero
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_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 (from schema)
- action_not_supported
- bad_xpath
- invalid_command
- malformed_command
- method_not_allowed
- session_timeout
- version_not_supported
Schema
_errors object[]
Array [code stringdetails objecthelp stringmessage string]- _request_id string
{
"_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"
}