Create a hip object

POST 
/sse/config/v1/hip-objects

Create a hip object.

Request

Query Parameters

folder stringrequired

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
criteria object
is_installed boolean
Default value: true
Is Installed
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
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
real_time_protection string
Possible values: [no, yes, not-available]
real time protection
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
exclude_vendor boolean
vendor object[]
Vendor name
Array [
name stringrequired
Possible values: <= 103 characters
product string[]
Possible values: <= 1023 characters, Value must match regular expression .*
]
certificate object

criteria object

certificate_attributes object[]

Array [

name stringrequired

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 objectrequired
plist object[]
Array [
key object[]
Array [
name stringrequired
Possible values: <= 1023 characters
Key name
negate boolean
Value does not exist or match specified value data
value string
Possible values: <= 1024 characters, Value must match regular expression .*
Key value
]
name stringrequired
Possible values: <= 1023 characters
Preference list
negate boolean
Plist does not exist
]
process_list object[]
Array [
name stringrequired
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 stringrequired
Possible values: <= 1023 characters
Registry key
negate boolean
Key does not exist or match specified value data
registry_value object[]
Array [
name stringrequired
Possible values: <= 1023 characters
Registry value name
negate boolean
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
vendor object[]
Vendor name
Array [
name stringrequired
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
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
exclude_vendor boolean
vendor object[]
Vendor name
Array [
name stringrequired
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 string
Possible values: [encrypted, unencrypted, partial, unknown]
Default value: encrypted
is_not
is_not string
Possible values: [encrypted, unencrypted, partial, unknown]
Default value: encrypted
name stringrequired
Possible values: <= 1023 characters
Encryption location
]
is_installed boolean
Default value: true
Is Installed
exclude_vendor boolean
vendor object[]
Vendor name
Array [
name stringrequired
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
vendor object[]
Vendor name
Array [
name stringrequired
Possible values: <= 103 characters
product string[]
Possible values: <= 1023 characters, Value must match regular expression .*
]
host_info object

criteria objectrequired

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

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

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

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

managed boolean

If device is managed

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

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

mobile_device object

criteria object

applications object

has_malware object

oneOf

no

no object

yes

yes object

excludes object[]

Array [

hash string

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

application hash

name stringrequired

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 stringrequired

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

contains stringrequired

Possible values: <= 255 characters

is

is stringrequired

Possible values: <= 255 characters

is_not

is_not stringrequired

Possible values: <= 255 characters

jailbroken boolean

If device is by rooted/jailbroken

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

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

passcode_set boolean

If device's passcode is present

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

name stringrequired

Possible values: <= 31 characters

Alphanumeric string [ 0-9a-zA-Z._-]

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_enabled string
Possible values: [no, yes, not-available]
is enabled
is_installed boolean
Default value: yes
Is Installed
missing_patches object
check stringrequired
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_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
exclude_vendor boolean
Default value: no
vendor object[]
Vendor name
Array [
name stringrequired
Possible values: <= 103 characters
product string[]
Possible values: <= 1023 characters, Value must match regular expression .*
Product name
]

Responses

201

Created

400

Bad Request

application/json

Schema

Schema

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

Example (from schema)

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

input_format_mismatch

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Input Format Mismatch: input-format=json"
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_object

Invalid Object

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Invalid Object"
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_query_parameter

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Invalid Query Parameter: location=invalid"
    }
  ],
  "_request_id": "abcd-1234"
}

missing_body

Missing Body

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Missing Body"
    }
  ],
  "_request_id": "abcd-1234"
}

missing_query_parameter

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Missing Query Parameter: name"
    }
  ],
  "_request_id": "abcd-1234"
}

output_format_mismatch

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Output Format Mismatch: output-format=json Accept=xml"
    }
  ],
  "_request_id": "abcd-1234"
}

401

Unauthorized

application/json

Schema

Schema

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

Example (from schema)

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

auth_not_authenticated

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Not Authenticated"
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_credential

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Invalid Credential"
    }
  ],
  "_request_id": "abcd-1234"
}

key_expired

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Key Expired"
    }
  ],
  "_request_id": "abcd-1234"
}

key_too_long

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Key Too Long"
    }
  ],
  "_request_id": "abcd-1234"
}

need_password_change

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "The password needs to be changed."
    }
  ],
  "_request_id": "abcd-1234"
}

403

Forbidden

application/json

Schema

Schema

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

Example (from schema)

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

auth_unauthorized

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "details": {},
      "message": "Unauthorized"
    }
  ],
  "_request_id": "abcd-1234"
}

409

Conflict

application/json

Schema

Schema

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

Example (from schema)

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

name_not_unique

Name Not Unique

{
  "_errors": [
    {
      "code": "E006",
      "details": {},
      "message": "Name Not Unique"
    }
  ],
  "_request_id": "abcd-1234"
}

object_not_unique

Object Not Unique

{
  "_errors": [
    {
      "code": "E016",
      "details": {},
      "message": "Object Not Unique"
    }
  ],
  "_request_id": "abcd-1234"
}

reference_not_zero

Reference Not Zero

{
  "_errors": [
    {
      "code": "E009",
      "details": {},
      "message": "Reference Not Zero"
    }
  ],
  "_request_id": "abcd-1234"
}

default

General Errors

application/json

Schema

Schema

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

Example (from schema)

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

action_not_supported

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Action Not Supported: move"
    }
  ],
  "_request_id": "abcd-1234"
}

bad_xpath

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "details": {},
      "message": "Bad XPath"
    }
  ],
  "_request_id": "abcd-1234"
}

invalid_command

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Invalid Command"
    }
  ],
  "_request_id": "abcd-1234"
}

malformed_command

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Malformed Command"
    }
  ],
  "_request_id": "abcd-1234"
}

method_not_allowed

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Method Not Supported"
    }
  ],
  "_request_id": "abcd-1234"
}

session_timeout

Session Timeout

{
  "_errors": [
    {
      "code": 4,
      "details": {},
      "message": "Session Timeout"
    }
  ],
  "_request_id": "abcd-1234"
}

version_not_supported

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "details": {},
      "message": "Version Not Supported"
    }
  ],
  "_request_id": "abcd-1234"
}

Loading...