Get a HIP object by ID

GET 
/sse/config/v1/hip-objects/:id

Get a HIP object by ID.

Request

Path Parameters

id stringrequired

The resource's unique identifier.

Responses

200

Get the hip object by id.

application/json

Schema

Schema

any

Example (from schema)

[
  {
    "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"
          ]
        }
      ]
    }
  }
]

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_query_parameter

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "details": {},
      "message": "Invalid Query Parameter: location=invalid"
    }
  ],
  "_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"
}

404

Not Found

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"
}

object_not_present

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "details": {},
      "message": "Object Not Present"
    }
  ],
  "_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...