Config reports

>>>

GET /api/config_reports
Список всех отчетов

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
search
необязательно

отфильтровать результаты

Validations:

  • Must be a String
order
необязательно

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
необязательно

Номер страницы, начиная с 1

Validations:

  • Must be a number.
per_page
необязательно

Число элементов на странице

Validations:

  • Must be a number.

Search fields

Field name Тип 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
location string
log text
organization string
origin string
pending integer
reported datetime
resource text
restarted integer
skipped integer
>>>

GET /api/config_reports/:id
Показать отчет

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
id
обязательно

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
Создать отчет

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
config_report
обязательно

Validations:

  • Must be a Hash
config_report[host]
обязательно

Имя узла или имя сертификата

Validations:

  • Must be a String
config_report[reported_at]
обязательно

Время отчета (UTC)

Validations:

  • Must be a String
config_report[status]
обязательно

Хэш итогового состояния

Validations:

  • Must be a Hash
config_report[metrics]
обязательно

Хэш метрики отчета (может быть {})

Validations:

  • Must be a Hash
config_report[logs]
необязательно , nil разрешен

Доп. массив хэшей журнала

Validations:

  • Must be an array of any type
>>>

DELETE /api/config_reports/:id
Удалить отчет

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
id
обязательно

Validations:

  • Must be a String
>>>

GET /api/hosts/:host_id/config_reports/last
Показать последний отчет узла

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer
id
обязательно

Validations:

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