admin-back

Перед работой api сервиса рекомендуется ознакомиться с архитектурой продукта и особенностями обращения к api с использованием Bearer Token Authentication.

Для работы с api требуется добавить /api/v1 в начало эндпоинта, всё что находится за /api/v1 является зашишённым и работает только с использованием механизма авторизации.

Адрес запроса к защищённому эндпоинту /about будет иметь вид:

http(s)://astra-monitoring.server/api/v1/about

Примечание

С документацией в формате swagger можно ознакомиться на запущенном сервере используя адрес: http(s)://astra-monitoring.server/api/v1/docs/index.html

Ниже представлена полная документация на api admin-back сервис бэкенда платформы. Он выступает централизованой точкой входа для фронтенда, а так же проксирует запросы к другим сервисам платформы.

GET /about

info page

Status Codes:
Response JSON Object:

  • branch (string)

  • builddate (string)

  • goarch (string)

  • goos (string)

  • goversion (string)

  • revision (string)

  • version (string)

GET /accounts

Retrieves all accounts information

Query Parameters:

  • auth (array)

  • deleted (boolean)

  • limit (integer)

  • page (integer)

  • privacy (array)

  • q (string)

  • security (array)

  • type (array)

Status Codes:
Response JSON Object:

  • accounts[].created_at (string)

  • accounts[].data (object)

  • accounts[].deleted_at (string)

  • accounts[].id (string)

  • accounts[].name (string)

  • accounts[].type (string)

  • accounts[].updated_at (string)

  • paging.current_page (integer)

  • paging.next_page (integer)

  • paging.per_page (integer)

  • paging.previous_page (integer)

  • paging.total (integer)

  • paging.total_page (integer)

POST /accounts

Create a new account

Request JSON Object:

  • data (object)

  • name (string)

  • type (string)

Status Codes:
Response JSON Object:

  • created_at (string)

  • data (object)

  • deleted_at (string)

  • id (string)

  • name (string)

  • type (string)

  • updated_at (string)

DELETE /accounts/{id}

Hard delete account

Parameters:

  • id (string) – Account id

Status Codes:
Response JSON Object:

  • message (any)

GET /accounts/{id}

Retrieves account information

Parameters:

  • id (string) – Account ID

Status Codes:
Response JSON Object:

  • created_at (string)

  • data (object)

  • deleted_at (string)

  • id (string)

  • name (string)

  • type (string)

  • updated_at (string)

PATCH /accounts/{id}

Update account

Parameters:

  • id (string) – Account id

Request JSON Object:

  • data (object)

  • name (string)

  • type (string)

Status Codes:
Response JSON Object:

  • created_at (string)

  • data (object)

  • deleted_at (string)

  • id (string)

  • name (string)

  • type (string)

  • updated_at (string)

GET /agents

Get all agents from DB by query parameters

Query Parameters:

  • q (string) – Search name of hostname by substring

  • page (integer) – pagination: page number

  • limit (integer) – pagination: number rows on page

  • active (boolean) – Only active agents

Status Codes:
Response JSON Object:

  • agents[].agent_upstream.address_http (string)

  • agents[].agent_upstream.address_https (string)

  • agents[].agent_upstream.auth_token (string)

  • agents[].agent_upstream.id (string)

  • agents[].agent_upstream.name (string)

  • agents[].agent_upstream.type (string)

  • agents[].config.author (string)

  • agents[].config.config.exporters.enabled (boolean)

  • agents[].config.config.exporters.exporters[].address (string)

  • agents[].config.config.exporters.exporters[].args (string)

  • agents[].config.config.exporters.exporters[].config (string)

  • agents[].config.config.exporters.exporters[].config_filename (string) – For SettingsType = args

  • agents[].config.config.exporters.exporters[].disabled (boolean)

  • agents[].config.config.exporters.exporters[].go_metrics (boolean) – For SettingsType = am

  • agents[].config.config.exporters.exporters[].interval_sec (number)

  • agents[].config.config.exporters.exporters[].labels (object)

  • agents[].config.config.exporters.exporters[].name (string)

  • agents[].config.config.exporters.exporters[].settings_type (string)

  • agents[].config.config.exporters.exporters[].status (string)

  • agents[].config.config.exporters.exporters[].version (string) – For both

  • agents[].config.config.logs.enabled (boolean)

  • agents[].config.config.logs.self_logs (boolean)

  • agents[].config.config.logs.use_local_config (boolean)

  • agents[].config.config.logs.vector_configs[].id (string)

  • agents[].config.config.logs.vector_configs[].name (string)

  • agents[].config.config.logs.version (string)

  • agents[].config.config.metrics.custom_targets[].disabled (boolean)

  • agents[].config.config.metrics.custom_targets[].interval_sec (number)

  • agents[].config.config.metrics.custom_targets[].labels (object)

  • agents[].config.config.metrics.custom_targets[].metrics_path (string)

  • agents[].config.config.metrics.custom_targets[].name (string)

  • agents[].config.config.metrics.custom_targets[].status (string)

  • agents[].config.config.metrics.custom_targets[].target (string)

  • agents[].config.config.metrics.enabled (boolean)

  • agents[].config.config.metrics.use_local_config (boolean)

  • agents[].config.config.metrics.version (string)

  • agents[].config.config.snmp.enabled (boolean)

  • agents[].config.config.snmp.targets[].disabled (boolean)

  • agents[].config.config.snmp.targets[].fqdn (string)

  • agents[].config.config.snmp.targets[].labels (object)

  • agents[].config.config.snmp.targets[].mib_files_names[] (string)

  • agents[].config.config.snmp.targets[].modules[] (string)

  • agents[].config.config.snmp.targets[].name (string)

  • agents[].config.config.snmp.targets[].port (integer)

  • agents[].config.config.snmp.targets[].retries (integer)

  • agents[].config.config.snmp.targets[].status (string)

  • agents[].config.config.snmp.targets[].tech_account_name (string)

  • agents[].config.config.snmp.targets[].tech_auth_id (string)

  • agents[].config.config.snmp.targets[].timeout (integer)

  • agents[].config.config.snmp.targets[].version (any)

  • agents[].config.created_time (string)

  • agents[].config.force_local (boolean)

  • agents[].config.upstream_id (string)

  • agents[].config.version (integer)

  • agents[].created_time (string)

  • agents[].description (string)

  • agents[].disabled_time (string)

  • agents[].id (string)

  • agents[].isLimitExceeded (boolean)

  • agents[].is_disabled (boolean)

  • agents[].name (string)

  • agents[].no_configuration (boolean)

  • agents[].state.arch (string)

  • agents[].state.config_applied_version (integer)

  • agents[].state.config_updated_time (string)

  • agents[].state.deployment (string)

  • agents[].state.hostname (string)

  • agents[].state.last_request_time (string)

  • agents[].state.os (string)

  • agents[].state.restart_count (integer)

  • agents[].state.runtime (string)

  • agents[].state.startup_time (string)

  • agents[].state.status (string)

  • agents[].state.type (string)

  • agents[].state.version (string)

  • agents[].updated_time (string)

  • agents[].upstream.address_http (string)

  • agents[].upstream.address_https (string)

  • agents[].upstream.auth_token (string)

  • agents[].upstream.id (string)

  • agents[].upstream.name (string)

  • agents[].upstream.type (string)

  • paging.current_page (integer)

  • paging.next_page (integer)

  • paging.per_page (integer)

  • paging.previous_page (integer)

  • paging.total (integer)

  • paging.total_page (integer)

DELETE /agents/{id}

Delete agent by ID

Parameters:

  • id (string) – Agent ID

Status Codes:
Response JSON Object:

  • message (any)

GET /agents/{id}

Get agent information from DB by ID

Parameters:

  • id (string) – Agent ID

Status Codes:
Response JSON Object:

  • agent_upstream.address_http (string)

  • agent_upstream.address_https (string)

  • agent_upstream.auth_token (string)

  • agent_upstream.id (string)

  • agent_upstream.name (string)

  • agent_upstream.type (string)

  • config.author (string)

  • config.config.exporters.enabled (boolean)

  • config.config.exporters.exporters[].address (string)

  • config.config.exporters.exporters[].args (string)

  • config.config.exporters.exporters[].config (string)

  • config.config.exporters.exporters[].config_filename (string) – For SettingsType = args

  • config.config.exporters.exporters[].disabled (boolean)

  • config.config.exporters.exporters[].go_metrics (boolean) – For SettingsType = am

  • config.config.exporters.exporters[].interval_sec (number)

  • config.config.exporters.exporters[].labels (object)

  • config.config.exporters.exporters[].name (string)

  • config.config.exporters.exporters[].settings_type (string)

  • config.config.exporters.exporters[].status (string)

  • config.config.exporters.exporters[].version (string) – For both

  • config.config.logs.enabled (boolean)

  • config.config.logs.self_logs (boolean)

  • config.config.logs.use_local_config (boolean)

  • config.config.logs.vector_configs[].id (string)

  • config.config.logs.vector_configs[].name (string)

  • config.config.logs.version (string)

  • config.config.metrics.custom_targets[].disabled (boolean)

  • config.config.metrics.custom_targets[].interval_sec (number)

  • config.config.metrics.custom_targets[].labels (object)

  • config.config.metrics.custom_targets[].metrics_path (string)

  • config.config.metrics.custom_targets[].name (string)

  • config.config.metrics.custom_targets[].status (string)

  • config.config.metrics.custom_targets[].target (string)

  • config.config.metrics.enabled (boolean)

  • config.config.metrics.use_local_config (boolean)

  • config.config.metrics.version (string)

  • config.config.snmp.enabled (boolean)

  • config.config.snmp.targets[].disabled (boolean)

  • config.config.snmp.targets[].fqdn (string)

  • config.config.snmp.targets[].labels (object)

  • config.config.snmp.targets[].mib_files_names[] (string)

  • config.config.snmp.targets[].modules[] (string)

  • config.config.snmp.targets[].name (string)

  • config.config.snmp.targets[].port (integer)

  • config.config.snmp.targets[].retries (integer)

  • config.config.snmp.targets[].status (string)

  • config.config.snmp.targets[].tech_account_name (string)

  • config.config.snmp.targets[].tech_auth_id (string)

  • config.config.snmp.targets[].timeout (integer)

  • config.config.snmp.targets[].version (any)

  • config.created_time (string)

  • config.force_local (boolean)

  • config.upstream_id (string)

  • config.version (integer)

  • created_time (string)

  • description (string)

  • disabled_time (string)

  • id (string)

  • isLimitExceeded (boolean)

  • is_disabled (boolean)

  • name (string)

  • no_configuration (boolean)

  • state.arch (string)

  • state.config_applied_version (integer)

  • state.config_updated_time (string)

  • state.deployment (string)

  • state.hostname (string)

  • state.last_request_time (string)

  • state.os (string)

  • state.restart_count (integer)

  • state.runtime (string)

  • state.startup_time (string)

  • state.status (string)

  • state.type (string)

  • state.version (string)

  • updated_time (string)

  • upstream.address_http (string)

  • upstream.address_https (string)

  • upstream.auth_token (string)

  • upstream.id (string)

  • upstream.name (string)

  • upstream.type (string)

PATCH /agents/{id}

Update agent information

Parameters:

  • id (string) – Agent ID

Request JSON Object:

  • config.exporters.enabled (boolean)

  • config.exporters.exporters[].address (string) – For both

  • config.exporters.exporters[].args (string) – For SettingsType = args_config

  • config.exporters.exporters[].config (string)

  • config.exporters.exporters[].config_filename (string)

  • config.exporters.exporters[].disabled (boolean)

  • config.exporters.exporters[].go_metrics (boolean) – For SettingsType = am_config

  • config.exporters.exporters[].interval_sec (number)

  • config.exporters.exporters[].labels (object)

  • config.exporters.exporters[].name (string)

  • config.exporters.exporters[].settings_type (string)

  • config.logs.enabled (boolean)

  • config.logs.self_logs (boolean)

  • config.logs.vector_configs_ids[] (string)

  • config.metrics.custom_targets[].disabled (boolean)

  • config.metrics.custom_targets[].interval_sec (number)

  • config.metrics.custom_targets[].labels (object)

  • config.metrics.custom_targets[].metrics_path (string)

  • config.metrics.custom_targets[].name (string)

  • config.metrics.custom_targets[].target (string)

  • config.metrics.enabled (boolean)

  • config.snmp_poll.enabled (boolean)

  • config.snmp_poll.targets[].disabled (boolean)

  • config.snmp_poll.targets[].fqdn (string)

  • config.snmp_poll.targets[].labels (object)

  • config.snmp_poll.targets[].mib_files_names[] (string)

  • config.snmp_poll.targets[].modules[] (string)

  • config.snmp_poll.targets[].name (string)

  • config.snmp_poll.targets[].port (integer)

  • config.snmp_poll.targets[].tech_account_name (string)

  • config.snmp_poll.targets[].tech_auth_id (string)

  • config.snmp_poll.targets[].version (any)

  • description (string)

  • name (string)

  • upstream.name (string)

Status Codes:
Response JSON Object:

  • agent_upstream.address_http (string)

  • agent_upstream.address_https (string)

  • agent_upstream.auth_token (string)

  • agent_upstream.id (string)

  • agent_upstream.name (string)

  • agent_upstream.type (string)

  • config.author (string)

  • config.config.exporters.enabled (boolean)

  • config.config.exporters.exporters[].address (string)

  • config.config.exporters.exporters[].args (string)

  • config.config.exporters.exporters[].config (string)

  • config.config.exporters.exporters[].config_filename (string) – For SettingsType = args

  • config.config.exporters.exporters[].disabled (boolean)

  • config.config.exporters.exporters[].go_metrics (boolean) – For SettingsType = am

  • config.config.exporters.exporters[].interval_sec (number)

  • config.config.exporters.exporters[].labels (object)

  • config.config.exporters.exporters[].name (string)

  • config.config.exporters.exporters[].settings_type (string)

  • config.config.exporters.exporters[].status (string)

  • config.config.exporters.exporters[].version (string) – For both

  • config.config.logs.enabled (boolean)

  • config.config.logs.self_logs (boolean)

  • config.config.logs.use_local_config (boolean)

  • config.config.logs.vector_configs[].id (string)

  • config.config.logs.vector_configs[].name (string)

  • config.config.logs.version (string)

  • config.config.metrics.custom_targets[].disabled (boolean)

  • config.config.metrics.custom_targets[].interval_sec (number)

  • config.config.metrics.custom_targets[].labels (object)

  • config.config.metrics.custom_targets[].metrics_path (string)

  • config.config.metrics.custom_targets[].name (string)

  • config.config.metrics.custom_targets[].status (string)

  • config.config.metrics.custom_targets[].target (string)

  • config.config.metrics.enabled (boolean)

  • config.config.metrics.use_local_config (boolean)

  • config.config.metrics.version (string)

  • config.config.snmp.enabled (boolean)

  • config.config.snmp.targets[].disabled (boolean)

  • config.config.snmp.targets[].fqdn (string)

  • config.config.snmp.targets[].labels (object)

  • config.config.snmp.targets[].mib_files_names[] (string)

  • config.config.snmp.targets[].modules[] (string)

  • config.config.snmp.targets[].name (string)

  • config.config.snmp.targets[].port (integer)

  • config.config.snmp.targets[].retries (integer)

  • config.config.snmp.targets[].status (string)

  • config.config.snmp.targets[].tech_account_name (string)

  • config.config.snmp.targets[].tech_auth_id (string)

  • config.config.snmp.targets[].timeout (integer)

  • config.config.snmp.targets[].version (any)

  • config.created_time (string)

  • config.force_local (boolean)

  • config.upstream_id (string)

  • config.version (integer)

  • created_time (string)

  • description (string)

  • disabled_time (string)

  • id (string)

  • isLimitExceeded (boolean)

  • is_disabled (boolean)

  • name (string)

  • no_configuration (boolean)

  • state.arch (string)

  • state.config_applied_version (integer)

  • state.config_updated_time (string)

  • state.deployment (string)

  • state.hostname (string)

  • state.last_request_time (string)

  • state.os (string)

  • state.restart_count (integer)

  • state.runtime (string)

  • state.startup_time (string)

  • state.status (string)

  • state.type (string)

  • state.version (string)

  • updated_time (string)

  • upstream.address_http (string)

  • upstream.address_https (string)

  • upstream.auth_token (string)

  • upstream.id (string)

  • upstream.name (string)

  • upstream.type (string)

GET /agents/{id}/can-delete

Check if agent can be deleted

Parameters:

  • id (string) – Agent ID

Status Codes:
Response JSON Object:

  • can_delete (boolean)

GET /agents/exporters

Get all available exporters

Status Codes:
Response JSON Object:

  • exporters[].address (string)

  • exporters[].args_template (string)

  • exporters[].available_settings_types[] (string)

  • exporters[].config_filename (string)

  • exporters[].config_template (string)

  • exporters[].description (string)

  • exporters[].fields_defaults (object)

  • exporters[].go_metrics (boolean)

  • exporters[].health_path (string)

  • exporters[].interval_sec (integer)

  • exporters[].log_level (string)

  • exporters[].metrics_path (string)

  • exporters[].name (string)

  • exporters[].proc_metrics (boolean)

  • exporters[].url (string)

GET /agents/info

Get all agent names, hostnames and statuses

Status Codes:
Response JSON Object:

  • agents (object)

GET /agents/sources

Get sources grouped by hostname

Query Parameters:

  • q (string) – Search targets by hostname by substring

  • page (integer) – pagination: page number

  • limit (integer) – pagination: number rows on page

  • active (boolean) – Only active targets

Status Codes:
Response JSON Object:

  • agents[].hostname (string)

  • agents[].id (string)

  • agents[].name (string)

  • agents[].sources[].address (string)

  • agents[].sources[].enabled (boolean)

  • agents[].sources[].name (string)

  • agents[].sources[].status (string)

  • agents[].sources[].type (string)

  • agents[].status (string)

  • paging.current_page (integer)

  • paging.next_page (integer)

  • paging.per_page (integer)

  • paging.previous_page (integer)

  • paging.total (integer)

  • paging.total_page (integer)

GET /agents/targets

Get targets grouped by hostname

Query Parameters:

  • q (string) – Search targets by hostname by substring

  • page (integer) – pagination: page number

  • limit (integer) – pagination: number rows on page

  • active (boolean) – Only active targets

Status Codes:
Response JSON Object:

  • paging.current_page (integer)

  • paging.next_page (integer)

  • paging.per_page (integer)

  • paging.previous_page (integer)

  • paging.total (integer)

  • paging.total_page (integer)

  • targets[].hostname (string) – For custom - label or target; for agent’s - label or agent’s hostname

  • targets[].targets[].labels (object)

  • targets[].targets[].name (string)

  • targets[].targets[].status (string)

GET /agents/upstreams/{id}

Get agents by upstream ID

Parameters:

  • id (string) – Upstream ID

Query Parameters:

  • q (string) – Search targets by hostname by substring

  • page (integer) – pagination: page number

  • limit (integer) – pagination: number rows on page

  • active (boolean) – Only active targets

Status Codes:
Response JSON Object:

  • agents[].agent_upstream.address_http (string)

  • agents[].agent_upstream.address_https (string)

  • agents[].agent_upstream.auth_token (string)

  • agents[].agent_upstream.id (string)

  • agents[].agent_upstream.name (string)

  • agents[].agent_upstream.type (string)

  • agents[].config.author (string)

  • agents[].config.config.exporters.enabled (boolean)

  • agents[].config.config.exporters.exporters[].address (string)

  • agents[].config.config.exporters.exporters[].args (string)

  • agents[].config.config.exporters.exporters[].config (string)

  • agents[].config.config.exporters.exporters[].config_filename (string) – For SettingsType = args

  • agents[].config.config.exporters.exporters[].disabled (boolean)

  • agents[].config.config.exporters.exporters[].go_metrics (boolean) – For SettingsType = am

  • agents[].config.config.exporters.exporters[].interval_sec (number)

  • agents[].config.config.exporters.exporters[].labels (object)

  • agents[].config.config.exporters.exporters[].name (string)

  • agents[].config.config.exporters.exporters[].settings_type (string)

  • agents[].config.config.exporters.exporters[].status (string)

  • agents[].config.config.exporters.exporters[].version (string) – For both

  • agents[].config.config.logs.enabled (boolean)

  • agents[].config.config.logs.self_logs (boolean)

  • agents[].config.config.logs.use_local_config (boolean)

  • agents[].config.config.logs.vector_configs[].id (string)

  • agents[].config.config.logs.vector_configs[].name (string)

  • agents[].config.config.logs.version (string)

  • agents[].config.config.metrics.custom_targets[].disabled (boolean)

  • agents[].config.config.metrics.custom_targets[].interval_sec (number)

  • agents[].config.config.metrics.custom_targets[].labels (object)

  • agents[].config.config.metrics.custom_targets[].metrics_path (string)

  • agents[].config.config.metrics.custom_targets[].name (string)

  • agents[].config.config.metrics.custom_targets[].status (string)

  • agents[].config.config.metrics.custom_targets[].target (string)

  • agents[].config.config.metrics.enabled (boolean)

  • agents[].config.config.metrics.use_local_config (boolean)

  • agents[].config.config.metrics.version (string)

  • agents[].config.config.snmp.enabled (boolean)

  • agents[].config.config.snmp.targets[].disabled (boolean)

  • agents[].config.config.snmp.targets[].fqdn (string)

  • agents[].config.config.snmp.targets[].labels (object)

  • agents[].config.config.snmp.targets[].mib_files_names[] (string)

  • agents[].config.config.snmp.targets[].modules[] (string)

  • agents[].config.config.snmp.targets[].name (string)

  • agents[].config.config.snmp.targets[].port (integer)

  • agents[].config.config.snmp.targets[].retries (integer)

  • agents[].config.config.snmp.targets[].status (string)

  • agents[].config.config.snmp.targets[].tech_account_name (string)

  • agents[].config.config.snmp.targets[].tech_auth_id (string)

  • agents[].config.config.snmp.targets[].timeout (integer)

  • agents[].config.config.snmp.targets[].version (any)

  • agents[].config.created_time (string)

  • agents[].config.force_local (boolean)

  • agents[].config.upstream_id (string)

  • agents[].config.version (integer)

  • agents[].created_time (string)

  • agents[].description (string)

  • agents[].disabled_time (string)

  • agents[].id (string)

  • agents[].isLimitExceeded (boolean)

  • agents[].is_disabled (boolean)

  • agents[].name (string)

  • agents[].no_configuration (boolean)

  • agents[].state.arch (string)

  • agents[].state.config_applied_version (integer)

  • agents[].state.config_updated_time (string)

  • agents[].state.deployment (string)

  • agents[].state.hostname (string)

  • agents[].state.last_request_time (string)

  • agents[].state.os (string)

  • agents[].state.restart_count (integer)

  • agents[].state.runtime (string)

  • agents[].state.startup_time (string)

  • agents[].state.status (string)

  • agents[].state.type (string)

  • agents[].state.version (string)

  • agents[].updated_time (string)

  • agents[].upstream.address_http (string)

  • agents[].upstream.address_https (string)

  • agents[].upstream.auth_token (string)

  • agents[].upstream.id (string)

  • agents[].upstream.name (string)

  • agents[].upstream.type (string)

  • paging.current_page (integer)

  • paging.next_page (integer)

  • paging.per_page (integer)

  • paging.previous_page (integer)

  • paging.total (integer)

  • paging.total_page (integer)

GET /license/product

Получение всех лицензий

Возвращает список всех лицензий

Status Codes:
Response JSON Object:

  • info.active_host_count (integer)

  • info.latest_license_expiry (string)

  • info.limited_license_count (integer)

  • info.nearest_license_expiry (string)

  • info.total_arms_count (integer)

  • info.total_ext_target_count (integer)

  • info.total_host_count (integer)

  • info.unlimited_license_count (integer)

  • license[].certSerialNumber (string) – Данные из сертификата

  • license[].certValidUntil (string)

  • license[].created (string)

  • license[].endDate (string)

  • license[].id (string)

  • license[].issuerEmail (string)

  • license[].issuerName (string)

  • license[].issuerOrg (string) – Данные выдающего из сертификата

  • license[].message (string)

  • license[].owner (any) – Поля владельца

  • license[].productId (string)

  • license[].productName (string)

  • license[].quantity_arm (integer)

  • license[].quantity_ext_target (integer)

  • license[].quantity_host (integer)

  • license[].recipientEmail (string)

  • license[].recipientName (string)

  • license[].recipientOrg (string) – Данные получателя из сертификата

  • license[].startDate (string)

  • license[].status (string) – Расчетные данные по лицензии

  • license[].type (string)

  • license[].updated (string)

DELETE /license/product/{id}

Удаление лицензии

Удаляет лицензию по её идентификатору

Parameters:

  • id (string) – Идентификатор лицензии

Status Codes:
Response JSON Object:

  • active_host_count (integer)

  • latest_license_expiry (string)

  • limited_license_count (integer)

  • nearest_license_expiry (string)

  • total_arms_count (integer)

  • total_ext_target_count (integer)

  • total_host_count (integer)

  • unlimited_license_count (integer)

GET /license/product/{id}

Получение лицензии по ID

Возвращает информацию о лицензии по её идентификатору

Parameters:

  • id (string) – Идентификатор лицензии

Status Codes:
Response JSON Object:

  • certSerialNumber (string) – Данные из сертификата

  • certValidUntil (string)

  • created (string)

  • endDate (string)

  • id (string)

  • issuerEmail (string)

  • issuerName (string)

  • issuerOrg (string) – Данные выдающего из сертификата

  • message (string)

  • owner (any) – Поля владельца

  • productId (string)

  • productName (string)

  • quantity_arm (integer)

  • quantity_ext_target (integer)

  • quantity_host (integer)

  • recipientEmail (string)

  • recipientName (string)

  • recipientOrg (string) – Данные получателя из сертификата

  • startDate (string)

  • status (string) – Расчетные данные по лицензии

  • type (string)

  • updated (string)

POST /license/product/upload

Загрузка новой лицензии

Загружает и проверяет новую лицензию из архивного файла

Status Codes:
Response JSON Object:

  • info.active_host_count (integer)

  • info.latest_license_expiry (string)

  • info.limited_license_count (integer)

  • info.nearest_license_expiry (string)

  • info.total_arms_count (integer)

  • info.total_ext_target_count (integer)

  • info.total_host_count (integer)

  • info.unlimited_license_count (integer)

  • license[].certSerialNumber (string) – Данные из сертификата

  • license[].certValidUntil (string)

  • license[].created (string)

  • license[].endDate (string)

  • license[].id (string)

  • license[].issuerEmail (string)

  • license[].issuerName (string)

  • license[].issuerOrg (string) – Данные выдающего из сертификата

  • license[].message (string)

  • license[].owner (any) – Поля владельца

  • license[].productId (string)

  • license[].productName (string)

  • license[].quantity_arm (integer)

  • license[].quantity_ext_target (integer)

  • license[].quantity_host (integer)

  • license[].recipientEmail (string)

  • license[].recipientName (string)

  • license[].recipientOrg (string) – Данные получателя из сертификата

  • license[].startDate (string)

  • license[].status (string) – Расчетные данные по лицензии

  • license[].type (string)

  • license[].updated (string)

GET /links/menu

Retrieves custom menu links

Status Codes:
Response JSON Object:

  • administration[].icon (string)

  • administration[].label (string)

  • administration[].url (string)

  • configurations[].icon (string)

  • configurations[].label (string)

  • configurations[].url (string)

  • monitoring[].icon (string)

  • monitoring[].label (string)

  • monitoring[].url (string)

GET /logs/graph

Getting data for a graph by filter

Query Parameters:

  • q (string) – Filter to search logs

  • search (string) – Global search across all fields

  • page (string) – Number of current page

  • limit (string) – Number of logs per page

  • sort (string) – Sorting field

  • log_type (string) – Type of logs

Status Codes:
Response JSON Object:

  • data_x[] (string)

  • log_level_series[].data[] (integer)

  • log_level_series[].name (string)

GET /logs/search

Retrieves a list of logs by filters

Query Parameters:

  • q (string) – Filter to search logs

  • search (string) – Global search across all fields

  • page (string) – Number of current page

  • limit (string) – Number of logs per page

  • sort (string) – Sorting field

  • type (string) – Type of logs

Status Codes:
Response JSON Object:

  • [].items[].agent_id (string)

  • [].items[].agent_name (string)

  • [].items[].collected_time (string)

  • [].items[].created_time (string)

  • [].items[].hostname (string)

  • [].items[].labels (object)

  • [].items[].level (string)

  • [].items[].message (string)

  • [].items[].service_name (string)

  • [].pagination.current_page (integer)

  • [].pagination.next_page (integer)

  • [].pagination.per_page (integer)

  • [].pagination.previous_page (integer)

  • [].pagination.total (integer)

  • [].pagination.total_page (integer)

GET /logs/uniqueAgents

Getting unique agents from the database

Query Parameters:

  • log_type (string) – Type of logs

Status Codes:
Response JSON Object:

  • [] (string)

GET /logs/uniqueFields/{field}

Getting unique values from the database

Parameters:

  • field (string) – Field to get unique values from

Query Parameters:

  • log_type (string) – Type of logs

Status Codes:
Response JSON Object:

  • [] (string)

GET /logs/uniqueValueByKey/{field}

Getting unique values from the database

Parameters:

  • field (string) – Field to get unique values from

Query Parameters:

  • log_type (string) – Type of logs

Status Codes:
Response JSON Object:

  • [] (string)

POST /snmp/exporter/generate

Generate exporter config

Request JSON Object:

  • accounts[] (string)

  • mibs[] (string)

  • modules (object)

Status Codes:
Response JSON Object:

  • message (any)

GET /snmp/mibs

Search MIBs

Query Parameters:

  • limit (integer)

  • page (integer)

  • q (string)

Status Codes:
Response JSON Object:

  • mibs[].created_at (string)

  • mibs[].data (string)

  • mibs[].dependencies[] (string)

  • mibs[].id (string)

  • mibs[].name (string)

  • mibs[].structure.children[].children[] (any)

  • mibs[].structure.children[].description (string)

  • mibs[].structure.children[].name (string)

  • mibs[].structure.children[].syntax (string)

  • mibs[].structure.children[].type (string)

  • mibs[].structure.name (string)

  • mibs[].updated_at (string)

  • paging.current_page (integer)

  • paging.next_page (integer)

  • paging.per_page (integer)

  • paging.previous_page (integer)

  • paging.total (integer)

  • paging.total_page (integer)

POST /snmp/mibs

Upload new MIB file

Upload and parse new mib file

Request JSON Object:

  • file (string) – (required)

Status Codes:
Response JSON Object:

  • dependencies[] (string)

  • id (string)

  • mib (string)

  • missing[] (string)

  • structure.children[].children[] (any)

  • structure.children[].description (string)

  • structure.children[].name (string)

  • structure.children[].syntax (string)

  • structure.children[].type (string)

  • structure.name (string)

DELETE /snmp/mibs/{id}

Delete MIB

Parameters:

  • id (string) – MIB id

Status Codes:
Response JSON Object:

  • message (any)

GET /snmp/mibs/{id}

Retrieves mib information

Parameters:

  • id (string) – MIB ID

Status Codes:
Response JSON Object:

  • created_at (string)

  • data (string)

  • dependencies[] (string)

  • id (string)

  • name (string)

  • structure.children[].children[] (any)

  • structure.children[].description (string)

  • structure.children[].name (string)

  • structure.children[].syntax (string)

  • structure.children[].type (string)

  • structure.name (string)

  • updated_at (string)

POST /snmp/mibs/base64

Create mib file from base64

The same as Create, but accept json with base64 encoded string

Request JSON Object:

  • data (string)

Status Codes:
Response JSON Object:

  • dependencies[] (string)

  • id (string)

  • mib (string)

  • missing[] (string)

  • structure.children[].children[] (any)

  • structure.children[].description (string)

  • structure.children[].name (string)

  • structure.children[].syntax (string)

  • structure.children[].type (string)

  • structure.name (string)

POST /snmp/mibs/check

Check MIB file and its dependencies if some are missing

Request JSON Object:

  • mib_files[] (string)

Status Codes:
Response JSON Object:

  • dependencies[] (string)

  • id (string)

  • mib (string)

  • missing[] (string)

  • structure.children[].children[] (any)

  • structure.children[].description (string)

  • structure.children[].name (string)

  • structure.children[].syntax (string)

  • structure.children[].type (string)

  • structure.name (string)

POST /snmp/mibs/modules

Retrieves mib modules

Request JSON Object:

  • mibs[] (string)

Status Codes:
Response JSON Object:

  • modules[].children[] (any)

  • modules[].description (string)

  • modules[].title (string)

  • modules[].value (string)

GET /templates

Retrieves all templates data

Query Parameters:

  • limit (integer)

  • page (integer)

  • q (string)

  • type (string)

Status Codes:
Response JSON Object:

  • paging.current_page (integer)

  • paging.next_page (integer)

  • paging.per_page (integer)

  • paging.previous_page (integer)

  • paging.total (integer)

  • paging.total_page (integer)

  • templates[].created_at (string)

  • templates[].data[] (integer)

  • templates[].id (string)

  • templates[].name (string)

  • templates[].type (string)

  • templates[].updated_at (string)

POST /templates

Create a new template

Request JSON Object:

  • data (object)

  • name (string)

  • type (string)

Status Codes:
Response JSON Object:

  • created_at (string)

  • data[] (integer)

  • id (string)

  • name (string)

  • type (string)

  • updated_at (string)

DELETE /templates/{id}

Delete template

Parameters:

  • id (string) – Template ID

Status Codes:
Response JSON Object:

  • message (any)

GET /templates/{id}

Get template by ID

Parameters:

  • id (string) – Template ID

Status Codes:
Response JSON Object:

  • created_at (string)

  • data[] (integer)

  • id (string)

  • name (string)

  • type (string)

  • updated_at (string)

PATCH /templates/{id}

Update template data

Parameters:

  • id (string) – Template ID

Request JSON Object:

  • data (object)

  • name (string)

Status Codes:
Response JSON Object:

  • created_at (string)

  • data[] (integer)

  • id (string)

  • name (string)

  • type (string)

  • updated_at (string)

GET /upstreams

Get all upstreams from DB by query parameters

Query Parameters:

  • q (string) – Search name or hostname by substring

  • page (integer) – pagination: page number

  • limit (integer) – pagination: number rows on page

  • active (boolean) – Filter by active upstreams

Status Codes:
Response JSON Object:

  • backends[].address_http (string)

  • backends[].address_https (string)

  • backends[].auth_token (string)

  • backends[].author (string)

  • backends[].connected_agents[] (string)

  • backends[].connection_linux[] (string)

  • backends[].connection_windows[] (string)

  • backends[].created_time (string)

  • backends[].deleted (boolean)

  • backends[].deleted_time (string)

  • backends[].description (string)

  • backends[].id (string)

  • backends[].name (string)

  • backends[].number_of_connected_agents (integer)

  • backends[].proxy_agent.hostname (string)

  • backends[].proxy_agent.id (string)

  • backends[].proxy_agent.name (string)

  • backends[].proxy_agent.status (string)

  • backends[].real_addresses[] (string)

  • backends[].type (string)

  • backends[].updated_time (string)

  • paging.current_page (integer)

  • paging.next_page (integer)

  • paging.per_page (integer)

  • paging.previous_page (integer)

  • paging.total (integer)

  • paging.total_page (integer)

  • upstreams[].address_http (string)

  • upstreams[].address_https (string)

  • upstreams[].auth_token (string)

  • upstreams[].author (string)

  • upstreams[].connected_agents[] (string)

  • upstreams[].connection_linux[] (string)

  • upstreams[].connection_windows[] (string)

  • upstreams[].created_time (string)

  • upstreams[].deleted (boolean)

  • upstreams[].deleted_time (string)

  • upstreams[].description (string)

  • upstreams[].id (string)

  • upstreams[].name (string)

  • upstreams[].number_of_connected_agents (integer)

  • upstreams[].proxy_agent.hostname (string)

  • upstreams[].proxy_agent.id (string)

  • upstreams[].proxy_agent.name (string)

  • upstreams[].proxy_agent.status (string)

  • upstreams[].real_addresses[] (string)

  • upstreams[].type (string)

  • upstreams[].updated_time (string)

DELETE /upstreams/{id}

Delete upstream by ID if it is not active

Parameters:

  • id (string) – Upstream ID

Status Codes:
Response JSON Object:

  • message (any)

GET /upstreams/{id}

Get upstream information from DB by ID

Parameters:

  • id (string) – Upstream ID

Status Codes:
Response JSON Object:

  • address_http (string)

  • address_https (string)

  • auth_token (string)

  • author (string)

  • connected_agents[] (string)

  • connection_linux[] (string)

  • connection_windows[] (string)

  • created_time (string)

  • deleted (boolean)

  • deleted_time (string)

  • description (string)

  • id (string)

  • name (string)

  • number_of_connected_agents (integer)

  • proxy_agent.hostname (string)

  • proxy_agent.id (string)

  • proxy_agent.name (string)

  • proxy_agent.status (string)

  • real_addresses[] (string)

  • type (string)

  • updated_time (string)

PATCH /upstreams/{id}

Update upstream by ID

Parameters:

  • id (string) – Upstream ID

Request JSON Object:

  • description (string)

  • name (string)

Status Codes:
Response JSON Object:

  • address_http (string)

  • address_https (string)

  • auth_token (string)

  • author (string)

  • connected_agents[] (string)

  • connection_linux[] (string)

  • connection_windows[] (string)

  • created_time (string)

  • deleted (boolean)

  • deleted_time (string)

  • description (string)

  • id (string)

  • name (string)

  • number_of_connected_agents (integer)

  • proxy_agent.hostname (string)

  • proxy_agent.id (string)

  • proxy_agent.name (string)

  • proxy_agent.status (string)

  • real_addresses[] (string)

  • type (string)

  • updated_time (string)

GET /upstreams/agents/{agent_id}

Get upstream by agent ID

Parameters:

  • agent_id (string) – Agent ID

Status Codes:
Response JSON Object:

  • address_http (string)

  • address_https (string)

  • auth_token (string)

  • author (string)

  • connected_agents[] (string)

  • connection_linux[] (string)

  • connection_windows[] (string)

  • created_time (string)

  • deleted (boolean)

  • deleted_time (string)

  • description (string)

  • id (string)

  • name (string)

  • number_of_connected_agents (integer)

  • proxy_agent.hostname (string)

  • proxy_agent.id (string)

  • proxy_agent.name (string)

  • proxy_agent.status (string)

  • real_addresses[] (string)

  • type (string)

  • updated_time (string)

GET /upstreams/agents/{id}

Get all connected agents to upstream by upstream ID

Parameters:

  • id (string) – Upstream ID

Status Codes:
Response JSON Object:

  • connected_agents[].hostname (string)

  • connected_agents[].id (string)

  • connected_agents[].name (string)

  • connected_agents[].status (string)

GET /vector

Get vector with pagination

Query Parameters:

  • q (string) – query

  • page (string) – page

  • limit (string) – limit

Status Codes:
Response JSON Object:

  • [].paging.current_page (integer)

  • [].paging.next_page (integer)

  • [].paging.per_page (integer)

  • [].paging.previous_page (integer)

  • [].paging.total (integer)

  • [].paging.total_page (integer)

  • [].vectors[].content (string)

  • [].vectors[].created_time (string)

  • [].vectors[].description (string)

  • [].vectors[].id (string)

  • [].vectors[].name (string)

  • [].vectors[].updated_time (string)

POST /vector

Creating a new config

Request JSON Object:

  • content (string)

  • description (string)

  • name (string)

Status Codes:
Response JSON Object:

  • content (string)

  • created_time (string)

  • description (string)

  • id (string)

  • name (string)

  • updated_time (string)

DELETE /vector/{id}

Delete config

Parameters:

  • id (string) – Collector id

Status Codes:
Response JSON Object:

  • message (any)

GET /vector/{id}

Get vector by ID

Parameters:

  • id (string) – Vector ID

Status Codes:
Response JSON Object:

  • content (string)

  • created_time (string)

  • description (string)

  • id (string)

  • name (string)

  • updated_time (string)

PATCH /vector/{id}

Update vector

Parameters:

  • id (string) – Vector ID

Request JSON Object:

  • content (string)

  • description (string)

  • name (string)

Status Codes:
Response JSON Object:

  • content (string)

  • created_time (string)

  • description (string)

  • id (string)

  • name (string)

  • updated_time (string)