Получение макроса по ID

Запрос

Тип	Метод
GET	/logmule_go_modules/{id}

Описание: При выполнении запроса будет возвращен макрос с соответствующим ID.

Если не указан параметр relations то подгружаются все связи обьекта. Если параметр указан но не имеет значений - связи не подгружаются. Если параметр указан и содержит значения (поля модели хранящие связанные сущности) то они будут заполнены в ответе.

Пример запроса

GET
http://127.0.0.1/cruddy/v2/logmule_go_modules/{id}

Path параметры запроса:

Параметр	Описание
{id}	Идентификатор макроса

Query параметры запроса:

Параметр	Описание
relations	Перечисление подгружаемых связей

Пример Query параметров запроса

[
  "logmule_go_rules"
]

Успешный ответ

Статус код: 200 – запрос успешно обработан.

Формат: JSON.

Тело ответа: модель макроса.

Пример ответа

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2023-12-20T00:00:01.652259Z",
  "updated_at": "2023-12-20T00:00:01.652259Z",
  "name": "string",
  "content": "string",
  "is_system": true,
  "logmule_go_rules": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created_at": "2023-12-20T00:00:01.652259Z",
      "updated_at": "2023-12-20T00:00:01.652259Z",
      "name": "string",
      "frontend_data": {
        "alert": {
          "id": "uuid",
          "trace_id": "uuid",
          "name": "string",
          "create_incident": true,
          "assign_to_customer": true,
          "risk_level": 5.35,
          "asset_ip": "string",
          "asset_hostname": "string",
          "asset_fqdn": "string",
          "asset_mac": "string",
          "first_and_last_logs": false,
          "trim_logs": 1,
          "template": "string",
          "mitre": ""
        },
        "grouper": {
          "id": "uuid",
          "trace_id": "uuid",
          "name": "string",
          "grouped_by": [
            "string"
          ],
          "aggregated_by": [
            "string"
          ],
          "grouped_time_field": "string",
          "grouped_time_type": "2023-12-20T00:00:01.652259Z",
          "detection_windows": 5,
          "detection_windows_unit": "ms",
          "aggregate_count": 1,
          "aggregate_unique": true
        },
        "actions": [
          {
            "TTL": "string",
            "key": {
              "_default": {
                "type": "value",
                "value": "string"
              }
            },
            "type": "store-set",
            "store": "string",
            "value": "string",
            "column": "string"
          }
        ],
        "conditions": [
          {
            "type": "compare-condition",
            "id": "uuid",
            "parentId": null,
            "negation": false,
            "compareFn": "eq",
            "expressions": [
              {
                "type": "logline-get",
                "value": "string"
              }
            ]
          }
        ],
        "version": 2
      },
      "test_data": [
        {}
      ],
      "settings": {
        "function_metrics": false,
        "is_constructor": false,
        "max_alerts": 1,
        "max_alerts_per_second": 1,
        "max_rule_memory_mb": 1
      },
      "active": true,
      "reload": true,
      "finding_id": "uuid",
      "description": "string",
      "lua": "string",
      "is_retro": false,
      "is_system": true,
      "stats": {
        "result_count": 1,
        "error_count": 0
      },
      "is_error": 0,
      "running_at": "2023-12-20T00:00:01.652259Z"
    }
  ],
  "_relations": {
    "logmule_go_rules": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }
}

Другие возможные ответы

Код	Ответ	Описание
400	id is empty	Не передан параметр “id”
404	not found	Объект не найден
500	Internal Server Error	Другие ошибки при получении объекта

Примечание: Текст ошибки не фиксированный, может изменяться в зависимости от фактического ответа получателя запроса.

Пример ответа

   
Код 400
   

{
  "error": "Bad Request",
  "error_code": 400
}



   
Код 404
   

{
  "error": "Not Found",
  "error_code": 404
}



   
Код 500
   

{
  "error": "Internal Server Error",
  "error_code": 500
}