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 boolean
Default value: true
Is Installed
last_scan_time object
oneOf
not_available
within
not_within
---
not_available object required
within object required
oneOf
days
hours
---
days integer
Possible values: >= 1 and <= 65535
Default value: 1
specify time in days
hours integer
Possible values: >= 1 and <= 65535
Default value: 24
specify time in hours
not_within object required
oneOf
days
hours
---
days integer
Possible values: >= 1 and <= 65535
Default value: 1
specify time in days
hours integer
Possible values: >= 1 and <= 65535
Default value: 24
specify 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 required
Possible values: <= 255 characters
greater_than string required
Possible values: <= 255 characters
is string required
Possible values: <= 255 characters
is_not string required
Possible values: <= 255 characters
less_equal string required
Possible values: <= 255 characters
less_than string required
Possible values: <= 255 characters
contains string required
Possible values: <= 255 characters
within object required
versions integer required
Possible values: >= 1 and <= 65535
Default value: 1
versions range
not_within object required
versions integer required
Possible values: >= 1 and <= 65535
Default value: 1
versions range
real_time_protection string
Possible values: [no, yes, not-available]
real time protection
virdef_version object
oneOf
within
not_within
---
within object required
oneOf
days
versions
---
days integer
Possible values: >= 1 and <= 65535
Default value: 1
specify time in days
versions integer
Possible values: >= 1 and <= 65535
Default value: 1
specify versions range
not_within object required
oneOf
days
versions
---
days integer
Possible values: >= 1 and <= 65535
Default value: 1
specify time in days
versions integer
Possible values: >= 1 and <= 65535
Default value: 1
specify versions range
exclude_vendor boolean
Default value: false
vendor object[]
Vendor name
Array [
name string required
Possible values: <= 103 characters
product string[]
Possible values: <= 1023 characters, Value must match regular expression .*
]
certificate object

criteria object

certificate_attributes object[]

Array [

name string required

Attribute Name

value string

Possible values: <= 1024 characters, Value must match regular expression .*

Key value

]

certificate_profile string

Profile for authenticating client certificates

custom_checks object
criteria object required
plist object[]
Array [
key object[]
Array [
name string required
Possible values: <= 1023 characters
Key name
negate boolean
Default value: false
Value does not exist or match specified value data
value string
Possible values: <= 1024 characters, Value must match regular expression .*
Key value
]
name string required
Possible values: <= 1023 characters
Preference list
negate boolean
Default value: false
Plist does not exist
]
process_list object[]
Array [
name string required
Possible values: <= 1023 characters
Process Name
running boolean
Default value: true
]
registry_key object[]
Array [
default_value_data string
Possible values: <= 1024 characters, Value must match regular expression .*
Registry key default value data
name string required
Possible values: <= 1023 characters
Registry key
negate boolean
Default value: false
Key does not exist or match specified value data
registry_value object[]
Array [
name string required
Possible values: <= 1023 characters
Registry value name
negate boolean
Default value: false
Value does not exist or match specified value data
value_data string
Possible values: <= 1024 characters, Value must match regular expression .*
Registry value data
]
]
data_loss_prevention object
criteria object
is_enabled string
Possible values: [no, yes, not-available]
is enabled
is_installed boolean
Default value: true
Is Installed
exclude_vendor boolean
Default value: false
vendor object[]
Vendor name
Array [
name string required
Possible values: <= 103 characters
product 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 boolean
Default value: true
Is Installed
last_backup_time object
oneOf
not_available
within
not_within
---
not_available object required
within object required
oneOf
days
hours
---
days integer
Possible values: >= 1 and <= 65535
Default value: 1
specify time in days
hours integer
Possible values: >= 1 and <= 65535
Default value: 24
specify time in hours
not_within object required
oneOf
days
hours
---
days integer
Possible values: >= 1 and <= 65535
Default value: 1
specify time in days
hours integer
Possible values: >= 1 and <= 65535
Default value: 24
specify time in hours
exclude_vendor boolean
Default value: false
vendor object[]
Vendor name
Array [
name string required
Possible values: <= 103 characters
product 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 string
Possible values: [encrypted, unencrypted, partial, unknown]
Default value: encrypted
is_not string
Possible values: [encrypted, unencrypted, partial, unknown]
Default value: encrypted
name string required
Possible values: <= 1023 characters
Encryption location
]
is_installed boolean
Default value: true
Is Installed
exclude_vendor boolean
Default value: false
vendor object[]
Vendor name
Array [
name string required
Possible values: <= 103 characters
product string[]
Possible values: <= 1023 characters, Value must match regular expression .*
]
firewall object
criteria object
is_enabled string
Possible values: [no, yes, not-available]
is enabled
is_installed boolean
Default value: true
Is Installed
exclude_vendor boolean
Default value: false
vendor object[]
Vendor name
Array [
name string required
Possible values: <= 103 characters
product 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 required

Possible values: <= 255 characters

is string required

Possible values: <= 255 characters

is_not string required

Possible values: <= 255 characters

domain object

oneOf

contains

is

is_not

---

contains string required

Possible values: <= 255 characters

is string required

Possible values: <= 255 characters

is_not string required

Possible values: <= 255 characters

host_id object

oneOf

contains

is

is_not

---

contains string required

Possible values: <= 255 characters

is string required

Possible values: <= 255 characters

is_not string required

Possible values: <= 255 characters

host_name object

oneOf

contains

is

is_not

---

contains string required

Possible values: <= 255 characters

is string required

Possible values: <= 255 characters

is_not string required

Possible values: <= 255 characters

managed boolean

If device is managed

os object

oneOf

contains

---

contains object required

oneOf

Microsoft

Apple

Google

Linux

Other

---

Microsoft string required

Possible values: <= 255 characters

Default value: All

Microsoft vendor

Apple string required

Possible values: <= 255 characters

Default value: All

Apple vendor

Google string required

Possible values: <= 255 characters

Default value: All

Google vendor

Linux string required

Possible values: <= 255 characters

Default value: All

Linux vendor

Other string required

Possible values: <= 255 characters

Other vendor

serial_number object

oneOf

contains

is

is_not

---

contains string required

Possible values: <= 255 characters

is string required

Possible values: <= 255 characters

is_not string required

Possible values: <= 255 characters

mobile_device object

criteria object

applications object

has_malware object

oneOf

no

yes

---

no object

yes object

excludes object[]

Array [

hash string

Possible values: <= 1024 characters, Value must match regular expression .*

application hash

name string required

Possible values: <= 31 characters

package string

Possible values: <= 1024 characters, Value must match regular expression .*

application package name

]

has_unmanaged_app boolean

Has apps that are not managed

includes object[]

Array [

hash string

Possible values: <= 1024 characters, Value must match regular expression .*

application hash

name string required

Possible values: <= 31 characters

package string

Possible values: <= 1024 characters, Value must match regular expression .*

application package name

]

disk_encrypted boolean

If device's disk is encrypted

imei object

oneOf

contains

is

is_not

---

contains string required

Possible values: <= 255 characters

is string required

Possible values: <= 255 characters

is_not string required

Possible values: <= 255 characters

jailbroken boolean

If device is by rooted/jailbroken

last_checkin_time object

oneOf

within

not_within

---

within object required

days integer required

Possible values: >= 1 and <= 365

Default value: 30

specify time in days

not_within object required

days integer required

Possible values: >= 1 and <= 365

Default value: 30

specify time in days

model object

oneOf

contains

is

is_not

---

contains string required

Possible values: <= 255 characters

is string required

Possible values: <= 255 characters

is_not string required

Possible values: <= 255 characters

passcode_set boolean

If device's passcode is present

phone_number object

oneOf

contains

is

is_not

---

contains string required

Possible values: <= 255 characters

is string required

Possible values: <= 255 characters

is_not string required

Possible values: <= 255 characters

tag object

oneOf

contains

is

is_not

---

contains string required

Possible values: <= 255 characters

is string required

Possible values: <= 255 characters

is_not string required

Possible values: <= 255 characters

name string required

Possible values: <= 31 characters

Alphanumeric 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 string
Possible values: <= 1023 characters, Value must match regular expression .*
SSID
mobile object
carrier string
Possible values: <= 1023 characters, Value must match regular expression .*
unknown object
is_not object
oneOf
wifi
mobile
ethernet
unknown
---
wifi object
ssid string
Possible values: <= 1023 characters, Value must match regular expression .*
SSID
mobile object
carrier string
Possible values: <= 1023 characters, Value must match regular expression .*
ethernet object
unknown object
patch_management object
criteria object
is_enabled string
Possible values: [no, yes, not-available]
is enabled
is_installed boolean
Default value: yes
Is Installed
missing_patches object
check string required
Possible values: [has-any, has-none, has-all]
Default value: has-any
patches 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 required
Possible values: <= 100000
greater_than integer required
Possible values: <= 100000
is integer required
Possible values: <= 100000
is_not integer required
Possible values: <= 100000
less_equal integer required
Possible values: <= 100000
less_than integer required
Possible values: <= 100000
exclude_vendor boolean
Default value: no
vendor object[]
Vendor name
Array [
name string required
Possible values: <= 103 characters
product string[]
Possible values: <= 1023 characters, Value must match regular expression .*
Product name
]

Responses

• 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 string
details object
help string
message 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 string
details object
help string
message 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 string
details object
help string
message 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 string
details object
help string
message 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 string
details object
help string
message 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 string
details object
help string
message 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"
}

Loading...