Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Integer

host_name
required

Validations:

  • String

host_uuid
optional

Validations:

  • String

payload
optional

iop payload including resolutions, rules, hits

Validations:

  • Hash

payload[resolutions]
optional

upload resolutions related to the hits

Validations:

  • Must be an Array of nested elements

payload[resolutions][rule_id]
required

rule id

Validations:

  • String

payload[resolutions][description]
optional

resolution description

Validations:

  • String

payload[resolutions][needs_reboot]
optional

Whether the resolution requires reboot

Validations:

  • Must be one of: true, false, 1, 0.

payload[resolutions][resolution_risk]
optional

resolution risk

Validations:

  • String

payload[resolutions][resolution_type]
optional

type

Validations:

  • String

payload[rules]
optional

Upload rules related to the hits

Validations:

  • Must be an Array of nested elements

payload[rules][rule_id]
required

rule id

Validations:

  • String

payload[rules][description]
optional

rule description

Validations:

  • String

payload[rules][category_name]
optional

category name

Validations:

  • String

payload[rules][impact_name]
optional

impact name

Validations:

  • String

payload[rules][summary]
optional

summary

Validations:

  • String

payload[rules][generic]
optional

generic

Validations:

  • String

payload[rules][reason]
optional

reason

Validations:

  • String

payload[rules][total_risk]
optional

total risk

Validations:

  • Must be a number.

payload[rules][reboot_required]
optional

reboot required

Validations:

  • Must be one of: true, false, 1, 0.

payload[rules][more_info]
optional

more info

Validations:

  • String

payload[rules][rating]
optional

rating

Validations:

  • Must be a number.

payload[hits]
optional

Upload hits information

Validations:

  • Must be an Array of nested elements

payload[hits][rule_id]
required

rule id

Validations:

  • String

payload[hits][title]
optional

rule title

Validations:

  • String

payload[hits][solution_url]
optional

solution url

Validations:

  • String

payload[hits][total_risk]
optional

total risk

Validations:

  • Must be a number.

payload[hits][likelihood]
optional

likelihood number

Validations:

  • Must be a number.

payload[hits][publish_date]
optional

publish date (YYYY-MM-DD)

Validations:

  • String

payload[hits][results_url]
optional

result url

Validations:

  • String

payload[details]
optional

upload hits details json

Validations:

  • String