Config reports

>>>

GET /api/config_reports
List all reports

Params

Param Name Description
search
Optional

filter results

Validations:

  • Must be String
order
Optional

sort results

Validations:

  • Must be String
page
Optional

paginate results

Validations:

  • Must be String
per_page
Optional

number of entries per request

Validations:

  • Must be String
>>>

GET /api/config_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/config_reports
Create a report

Params

Param Name Description
config_report
Required

Validations:

  • Must be a Hash
config_report[host]
Required

Hostname or certname

Validations:

  • Must be String
config_report[reported_at]
Required

UTC time of report

Validations:

  • Must be String
config_report[status]
Required

Hash of status type totals

Validations:

  • Must be Hash
config_report[metrics]
Required

Hash of report metrics, can be just {}

Validations:

  • Must be Hash
config_report[logs]
Optional , <span class="translation_missing" title="translation missing: en-GB.apipie.nil_allowed">Nil Allowed</span>

Optional array of log hashes

Validations:

  • Must be an array of any type
>>>

DELETE /api/config_reports/:id
Delete a report

Params

Param Name Description
id
Required

Validations:

  • Must be String
>>>

GET /api/hosts/:host_id/config_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.