GET /api/config_reports
List all reports

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

search
Optional

filter results

Validations:

  • Must be a String

order
Optional

Sort field and order, eg. ‘id DESC’

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

Search fields

Field name Tipo Possible values
applied integer
environment string
eventful true, false
failed integer
failed_restarts integer
host string
host_id integer
hostgroup string
hostgroup_fullname string
hostgroup_title string
last_report datetime
log text
origin string
pending integer
reported datetime
resource text
restarted integer
skipped integer

GET /api/config_reports/:id
Show a report

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

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
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

config_report
Required

Validations:

  • Must be a Hash

config_report[host]
Required

Hostname or certname

Validations:

  • Must be a String

config_report[reported_at]
Required

UTC time of report

Validations:

  • Must be a String

config_report[status]
Required

Hash of status type totals

Validations:

  • Must be a Hash

config_report[metrics]
Required

Hash of report metrics, can be just {}

Validations:

  • Must be a Hash

config_report[logs]
Optional , <span class="translation_missing" title="translation missing: gl.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
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

id
Required

Validations:

  • Must be a String


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

Params

Param Name Description
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer

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.