Config reports

>>>

GET /api/config_reports
Som alle rapporten op

Params

Param Name Description
location_id
Optional

Scope met locaties

Validations:

  • Must be a Integer
organization_id
Optional

Scope met organisaties

Validations:

  • Must be a Integer
search
Optional

filter resultaten

Validations:

  • Must be a String
order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
Optional

Pagineer de resultaten

Validations:

  • Must be a String
per_page
Optional

Aantal items per aanvraag

Validations:

  • Must be a String

Search fields

Field name Type 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
Bekijk een rapport

Params

Param Name Description
location_id
Optional

Scope met locaties

Validations:

  • Must be a Integer
organization_id
Optional

Scope met organisaties

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
Creeer een rapport

Params

Param Name Description
location_id
Optional

Scope met locaties

Validations:

  • Must be a Integer
organization_id
Optional

Scope met organisaties

Validations:

  • Must be a Integer
config_report
Required

Validations:

  • Must be a Hash
config_report[host]
Required

Hostnaam of certificaat naam

Validations:

  • Must be a String
config_report[reported_at]
Required

UTC tijd van het rapport

Validations:

  • Must be a String
config_report[status]
Required

Hash van status type totalen

Validations:

  • Must be a Hash
config_report[metrics]
Required

Hash van rapportage meetwaarden, kan gewoon {} zijn

Validations:

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

Optionele array van log hashes

Validations:

  • Must be an array of any type
>>>

DELETE /api/config_reports/:id
Verwijder een rapport

Params

Param Name Description
location_id
Optional

Scope met locaties

Validations:

  • Must be a Integer
organization_id
Optional

Scope met organisaties

Validations:

  • Must be a Integer
id
Required

Validations:

  • Must be a String
>>>

GET /api/hosts/:host_id/config_reports/last
Bekijk het laatste rapport voor een host

Params

Param Name Description
location_id
Optional

Scope met locaties

Validations:

  • Must be a Integer
organization_id
Optional

Scope met organisaties

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.