Reports

>>>

GET /api/reports
List all reports

Params

Param name Description
search
optional

filter results


Value: Must be String
order
optional

sort results


Value: Must be String
page
optional

paginate results


Value: Must be String
per_page
optional

number of entries per request


Value: Must be String
>>>

GET /api/reports/:id
Show a report

Params

Param name Description
id
required
Value: 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
Value: Must be a Hash
report[host]
required

Hostname or certname


Value: Must be String
report[reported_at]
required

UTC time of report


Value: Must be String
report[status]
required

Hash of status type totals


Value: Must be Hash
report[metrics]
required

Hash of report metrics, can be just {}


Value: Must be Hash
report[logs]
optional , nil allowed

Optional array of log hashes


Value: Must be an array of any type
>>>

DELETE /api/reports/:id
Delete a report

Params

Param name Description
id
required
Value: Must be String
>>>

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

Params

Param name Description
id
required
Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.