List HIP objects

GET 
/hip-objects

Retrieve a list HIP objects.

Request

Query Parameters

name string

The name of the configuration resource

folder string

The folder in which the resource is defined

snippet string

The snippet in which the resource is defined

device string

The device in which the resource is defined

offset number

Default value: 0

The offset into the list of results returned

limit number

Default value: 200

The maximum number of results per page

Responses

200

OK

application/json

Schema

Schema

data object[]
Array [
id stringrequired
UUID of the resource
name stringrequired
Possible values: <= 31 characters, Value must match regular expression ^[ a-zA-Z\d.-_]+$
The name of the HIP object
description string
Possible values: <= 255 characters
host_info object
criteria objectrequired
domain object
oneOf
contains
contains stringrequired
Possible values: <= 255 characters
is
is stringrequired
Possible values: <= 255 characters
is_not
is_not stringrequired
Possible values: <= 255 characters
os object
oneOf
contains
contains object required
oneOf
Microsoft
Microsoft stringrequired
Possible values: <= 255 characters
Default value: All
Microsoft vendor
Apple
Apple stringrequired
Possible values: <= 255 characters
Default value: All
Apple vendor
Google
Google stringrequired
Possible values: <= 255 characters
Default value: All
Google vendor
Linux
Linux stringrequired
Possible values: <= 255 characters
Default value: All
Linux vendor
Other
Other stringrequired
Possible values: <= 255 characters
Other vendor
client_version object
oneOf
contains
contains stringrequired
Possible values: <= 255 characters
is
is stringrequired
Possible values: <= 255 characters
is_not
is_not stringrequired
Possible values: <= 255 characters
host_name object
oneOf
contains
contains stringrequired
Possible values: <= 255 characters
is
is stringrequired
Possible values: <= 255 characters
is_not
is_not stringrequired
Possible values: <= 255 characters
host_id object
oneOf
contains
contains stringrequired
Possible values: <= 255 characters
is
is stringrequired
Possible values: <= 255 characters
is_not
is_not stringrequired
Possible values: <= 255 characters
managed boolean
If device is managed
serial_number object
oneOf
contains
contains stringrequired
Possible values: <= 255 characters
is
is stringrequired
Possible values: <= 255 characters
is_not
is_not stringrequired
Possible values: <= 255 characters
network_info object
criteria object
network object
oneOf
is
is object
oneOf
wifi
wifi object
ssid string
Possible values: <= 1023 characters, Value must match regular expression .*
SSID
mobile
mobile object
carrier string
Possible values: <= 1023 characters, Value must match regular expression .*
unknown
unknown object
is_not
is_not object
oneOf
wifi
wifi object
ssid string
Possible values: <= 1023 characters, Value must match regular expression .*
SSID
mobile
mobile object
carrier string
Possible values: <= 1023 characters, Value must match regular expression .*
ethernet
ethernet object
unknown
unknown object
patch_management object
criteria object
is_installed boolean
Default value: true
Is Installed
is_enabled
Possible values: [no, yes, not-available]
is enabled
missing_patches object
severity object
oneOf
greater_equal
greater_equal integerrequired
Possible values: <= 100000
greater_than
greater_than integerrequired
Possible values: <= 100000
is
is integerrequired
Possible values: <= 100000
is_not
is_not integerrequired
Possible values: <= 100000
less_equal
less_equal integerrequired
Possible values: <= 100000
less_than
less_than integerrequired
Possible values: <= 100000
patches string[]
Possible values: <= 1023 characters, Value must match regular expression .*
check required
Possible values: [has-any, has-none, has-all]
Default value: has-any
vendor object[]
Vendor name
Array [
name stringrequired
Possible values: <= 103 characters
product string[]
Possible values: <= 1023 characters, Value must match regular expression .*
Product name
]
exclude_vendor boolean
data_loss_prevention object
criteria object
is_installed boolean
Default value: true
Is Installed
is_enabled
Possible values: [no, yes, not-available]
is enabled
vendor object[]
Vendor name
Array [
name stringrequired
Possible values: <= 103 characters
product string[]
Possible values: <= 1023 characters, Value must match regular expression .*
Product name
]
exclude_vendor boolean
firewall object
criteria object
is_installed boolean
Default value: true
Is Installed
is_enabled
Possible values: [no, yes, not-available]
is enabled
vendor object[]
Vendor name
Array [
name stringrequired
Possible values: <= 103 characters
product string[]
Possible values: <= 1023 characters, Value must match regular expression .*
]
exclude_vendor boolean
anti_malware object
criteria object
virdef_version object
oneOf
within
within object required
oneOf
days
days integer
Possible values: >= 1 and <= 65535
Default value: 1
specify time in days
versions
versions integer
Possible values: >= 1 and <= 65535
Default value: 1
specify versions range
not_within
not_within object required
oneOf
days
days integer
Possible values: >= 1 and <= 65535
Default value: 1
specify time in days
versions
versions integer
Possible values: >= 1 and <= 65535
Default value: 1
specify versions range
product_version object
oneOf
greater_equal
greater_equal stringrequired
Possible values: <= 255 characters
greater_than
greater_than stringrequired
Possible values: <= 255 characters
is
is stringrequired
Possible values: <= 255 characters
is_not
is_not stringrequired
Possible values: <= 255 characters
less_equal
less_equal stringrequired
Possible values: <= 255 characters
less_than
less_than stringrequired
Possible values: <= 255 characters
contains
contains stringrequired
Possible values: <= 255 characters
within
within objectrequired
versions integerrequired
Possible values: >= 1 and <= 65535
Default value: 1
versions range
not_within
not_within objectrequired
versions integerrequired
Possible values: >= 1 and <= 65535
Default value: 1
versions range
is_installed boolean
Default value: true
Is Installed
real_time_protection
Possible values: [no, yes, not-available]
real time protection
last_scan_time object
oneOf
not_available
not_available objectrequired
within
within object required
oneOf
days
days integer
Possible values: >= 1 and <= 65535
Default value: 1
specify time in days
hours
hours integer
Possible values: >= 1 and <= 65535
Default value: 24
specify time in hours
not_within
not_within object required
oneOf
days
days integer
Possible values: >= 1 and <= 65535
Default value: 1
specify time in days
hours
hours integer
Possible values: >= 1 and <= 65535
Default value: 24
specify time in hours
vendor object[]
Vendor name
Array [
name stringrequired
Possible values: <= 103 characters
product string[]
Possible values: <= 1023 characters, Value must match regular expression .*
]
exclude_vendor boolean
disk_backup object
criteria object
is_installed boolean
Default value: true
Is Installed
last_backup_time object
oneOf
not_available
not_available objectrequired
within
within object required
oneOf
days
days integer
Possible values: >= 1 and <= 65535
Default value: 1
specify time in days
hours
hours integer
Possible values: >= 1 and <= 65535
Default value: 24
specify time in hours
not_within
not_within object required
oneOf
days
days integer
Possible values: >= 1 and <= 65535
Default value: 1
specify time in days
hours
hours integer
Possible values: >= 1 and <= 65535
Default value: 24
specify time in hours
vendor object[]
Vendor name
Array [
name stringrequired
Possible values: <= 103 characters
product string[]
Possible values: <= 1023 characters, Value must match regular expression .*
]
exclude_vendor boolean
disk_encryption object
criteria object
Encryption locations
is_installed boolean
Default value: true
Is Installed
encrypted_locations object[]
Array [
name stringrequired
Possible values: <= 1023 characters
Encryption location
encryption_state object
oneOf
is
is
Possible values: [encrypted, unencrypted, partial, unknown]
Default value: encrypted
is_not
is_not
Possible values: [encrypted, unencrypted, partial, unknown]
Default value: encrypted
]
vendor object[]
Vendor name
Array [
name stringrequired
Possible values: <= 103 characters
product string[]
Possible values: <= 1023 characters, Value must match regular expression .*
]
exclude_vendor boolean
custom_checks object
criteria objectrequired
process_list object[]
Array [
name stringrequired
Possible values: <= 1023 characters
Process Name
running boolean
Default value: true
]
registry_key object[]
Array [
name stringrequired
Possible values: <= 1023 characters
Registry key
default_value_data string
Possible values: <= 1024 characters, Value must match regular expression .*
Registry key default value data
negate boolean
Key does not exist or match specified value data
registry_value object[]
Array [
name stringrequired
Possible values: <= 1023 characters
Registry value name
value_data string
Possible values: <= 1024 characters, Value must match regular expression .*
Registry value data
negate boolean
Value does not exist or match specified value data
]
]
plist object[]
Array [
name stringrequired
Possible values: <= 1023 characters
Preference list
negate boolean
Plist does not exist
key object[]
Array [
name stringrequired
Possible values: <= 1023 characters
Key name
value string
Possible values: <= 1024 characters, Value must match regular expression .*
Key value
negate boolean
Value does not exist or match specified value data
]
]
mobile_device object
criteria object
jailbroken boolean
If device is by rooted/jailbroken
disk_encrypted boolean
If device's disk is encrypted
passcode_set boolean
If device's passcode is present
last_checkin_time object
oneOf
within
within objectrequired
days integerrequired
Possible values: >= 1 and <= 365
Default value: 30
specify time in days
not_within
not_within objectrequired
days integerrequired
Possible values: >= 1 and <= 365
Default value: 30
specify time in days
imei object
oneOf
contains
contains stringrequired
Possible values: <= 255 characters
is
is stringrequired
Possible values: <= 255 characters
is_not
is_not stringrequired
Possible values: <= 255 characters
model object
oneOf
contains
contains stringrequired
Possible values: <= 255 characters
is
is stringrequired
Possible values: <= 255 characters
is_not
is_not stringrequired
Possible values: <= 255 characters
phone_number object
oneOf
contains
contains stringrequired
Possible values: <= 255 characters
is
is stringrequired
Possible values: <= 255 characters
is_not
is_not stringrequired
Possible values: <= 255 characters
tag object
oneOf
contains
contains stringrequired
Possible values: <= 255 characters
is
is stringrequired
Possible values: <= 255 characters
is_not
is_not stringrequired
Possible values: <= 255 characters
applications object
has_malware object
oneOf
no
no object
yes
yes object
excludes object[]
Array [
name stringrequired
Possible values: <= 31 characters
package string
Possible values: <= 1024 characters, Value must match regular expression .*
application package name
hash string
Possible values: <= 1024 characters, Value must match regular expression .*
application hash
]
has_unmanaged_app boolean
Has apps that are not managed
includes object[]
Array [
name stringrequired
Possible values: <= 31 characters
package string
Possible values: <= 1024 characters, Value must match regular expression .*
application package name
hash string
Possible values: <= 1024 characters, Value must match regular expression .*
application hash
]
certificate object
criteria object
certificate_profile string
Profile for authenticating client certificates
certificate_attributes object[]
Array [
name stringrequired
Attribute Name
value string
Possible values: <= 1024 characters, Value must match regular expression .*
Key value
]
]
limit number

Default value: 200

offset number

Default value: 0

total number

Example (from schema)

{
  "data": [
    {
      "folder": "My Folder"
    },
    {
      "snippet": "My Snippet"
    },
    {
      "device": "My Device"
    }
  ],
  "limit": 200,
  "offset": 0,
  "total": 0
}

400

Bad Request

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

input_format_mismatch

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Input Format Mismatch: input-format=json",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

output_format_mismatch

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Output Format Mismatch: output-format=json Accept=xml",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

missing_query_parameter

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Missing Query Parameter: name",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_query_parameter

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Query Parameter: location=invalid",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

401

Unauthorized

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_not_authenticated

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "message": "Not Authenticated",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_credential

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "message": "Invalid Credential",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_too_long

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Too Long",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_expired

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Expired",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

need_password_change

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "message": "The password needs to be changed.",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

403

Forbidden

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_unauthorized

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "message": "Unauthorized",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

404

Not Found

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

object_not_present

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "message": "Object Not Present",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

default

General Errors

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

version_not_supported

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Version Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

method_not_allowed

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Method Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

action_not_supported

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Action Not Supported: move",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

bad_xpath

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "message": "Bad XPath",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_command

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

malformed_command

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Malformed Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

session_timeout

Session Timeout

{
  "_errors": [
    {
      "code": "4",
      "message": "Session Timeout",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Loading...