GET /api/reports
List all reports

Params

Param name Description
search
optional

filter results

Validations:

  • Must be a String

order
optional

sort results

Validations:

  • Must be a String

page
optional

paginate results

Validations:

  • Must be a String

per_page
optional

number of entries per request

Validations:

  • Must be a String


GET /api/reports/:id
Show a report

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/reports
Create a report

Params

Param name Description
report
required

Validations:

  • Must be a Hash

report[host]
required

Hostname or certname

Validations:

  • Must be a String

report[reported_at]
required

UTC time of report

Validations:

  • Must be a String

report[status]
required

Hash of status type totals

Validations:

  • Must be a Hash

report[metrics]
required

Hash of report metrics, can be just {}

Validations:

  • Must be a Hash

report[logs]
optional , nil allowed

Optional array of log hashes

Validations:

  • Must be an array of any type


DELETE /api/reports/:id
Delete a report

Params

Param name Description
id
required

Validations:

  • Must be a String


GET /api/hosts/:host_id/reports/last
Show the last report for a host

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.