Skip to main content

Create a hip object

POST 

https://api.sase.paloaltonetworks.com/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.

Body

The hip object you want to create

    anti_malware object
    criteria object
    is_installedboolean

    Is Installed

    Default value: true
    last_scan_time object
    oneOf
    product_version object
    oneOf
    real_time_protectionstring

    real time protection

    Possible values: [no, yes, not-available]

    virdef_version object
    oneOf
    exclude_vendorboolean
    Default value: false
    vendor object[]

    Vendor name

  • Array [
  • namestringrequired

    Possible values: <= 103 characters

    productstring[]

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

  • ]
  • certificate object
    criteria object
    certificate_attributes object[]
  • Array [
  • namestringrequired

    Attribute Name

    valuestring

    Key value

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

  • ]
  • certificate_profilestring

    Profile for authenticating client certificates

    custom_checks object
    criteria objectrequired
    plist object[]
  • Array [
  • key object[]
  • Array [
  • namestringrequired

    Key name

    Possible values: <= 1023 characters

    negateboolean

    Value does not exist or match specified value data

    Default value: false
    valuestring

    Key value

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

  • ]
  • namestringrequired

    Preference list

    Possible values: <= 1023 characters

    negateboolean

    Plist does not exist

    Default value: false
  • ]
  • process_list object[]
  • Array [
  • namestringrequired

    Process Name

    Possible values: <= 1023 characters

    runningboolean
    Default value: true
  • ]
  • registry_key object[]
  • Array [
  • default_value_datastring

    Registry key default value data

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

    namestringrequired

    Registry key

    Possible values: <= 1023 characters

    negateboolean

    Key does not exist or match specified value data

    Default value: false
    registry_value object[]
  • Array [
  • namestringrequired

    Registry value name

    Possible values: <= 1023 characters

    negateboolean

    Value does not exist or match specified value data

    Default value: false
    value_datastring

    Registry value data

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

  • ]
  • ]
  • data_loss_prevention object
    criteria object
    is_enabledstring

    is enabled

    Possible values: [no, yes, not-available]

    is_installedboolean

    Is Installed

    Default value: true
    exclude_vendorboolean
    Default value: false
    vendor object[]

    Vendor name

  • Array [
  • namestringrequired

    Possible values: <= 103 characters

    productstring[]

    Product name

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

  • ]
  • descriptionstring

    Possible values: <= 255 characters

    disk_backup object
    criteria object
    is_installedboolean

    Is Installed

    Default value: true
    last_backup_time object
    oneOf
    exclude_vendorboolean
    Default value: false
    vendor object[]

    Vendor name

  • Array [
  • namestringrequired

    Possible values: <= 103 characters

    productstring[]

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

  • ]
  • disk_encryption object
    criteria object

    Encryption locations

    encrypted_locations object[]
  • Array [
  • encryption_state object
    oneOf
    namestringrequired

    Encryption location

    Possible values: <= 1023 characters

  • ]
  • is_installedboolean

    Is Installed

    Default value: true
    exclude_vendorboolean
    Default value: false
    vendor object[]

    Vendor name

  • Array [
  • namestringrequired

    Possible values: <= 103 characters

    productstring[]

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

  • ]
  • firewall object
    criteria object
    is_enabledstring

    is enabled

    Possible values: [no, yes, not-available]

    is_installedboolean

    Is Installed

    Default value: true
    exclude_vendorboolean
    Default value: false
    vendor object[]

    Vendor name

  • Array [
  • namestringrequired

    Possible values: <= 103 characters

    productstring[]

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

  • ]
  • host_info object
    criteria objectrequired
    client_version object
    oneOf
    domain object
    oneOf
    host_id object
    oneOf
    host_name object
    oneOf
    managedboolean

    If device is managed

    os object
    oneOf
    serial_number object
    oneOf
    mobile_device object
    criteria object
    applications object
    has_malware object
    oneOf
    has_unmanaged_appboolean

    Has apps that are not managed

    includes object[]
  • Array [
  • hashstring

    application hash

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

    namestringrequired

    Possible values: <= 31 characters

    packagestring

    application package name

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

  • ]
  • disk_encryptedboolean

    If device's disk is encrypted

    imei object
    oneOf
    jailbrokenboolean

    If device is by rooted/jailbroken

    last_checkin_time object
    oneOf
    model object
    oneOf
    passcode_setboolean

    If device's passcode is present

    phone_number object
    oneOf
    tag object
    oneOf
    namestringrequired

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

    Possible values: <= 31 characters

    network_info object
    criteria object
    network object
    oneOf
    patch_management object
    criteria object
    is_enabledstring

    is enabled

    Possible values: [no, yes, not-available]

    is_installedboolean

    Is Installed

    Default value: yes
    missing_patches object
    checkstringrequired

    Possible values: [has-any, has-none, has-all]

    Default value: has-any
    patchesstring[]

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

    severity object
    oneOf
    exclude_vendorboolean
    Default value: no
    vendor object[]

    Vendor name

  • Array [
  • namestringrequired

    Possible values: <= 103 characters

    productstring[]

    Product name

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

  • ]

Responses

Created

Authorization: http

name: Bearertype: httpscheme: bearer
curl -L 'https://api.sase.paloaltonetworks.com/sse/config/v1/hip-objects' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
"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"
}
}
},
"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"
]
}
]
}
}'
Request Collapse all
Base URL
https://api.sase.paloaltonetworks.com
Auth
Parameters
— queryrequired
Body
{
  "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"
      }
    }
  },
  "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"
        ]
      }
    ]
  }
}
ResponseClear

Click the Send API Request button above and see the response here!