Получение хоста по ID

Запрос

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

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

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

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

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

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

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

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

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

Формат: JSON.

Тело ответа модель хоста.

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

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2023-12-20T00:00:01.652259Z",
  "updated_at": "2023-12-20T00:00:01.652259Z",
  "ip": "192.168.0.1",
  "mac": "string",
  "fqdn": "string",
  "properties": "string",
  "scan_begin": null,
  "scan_end": null,
  "service_asset_id": "09122f07-8b1e-48dc-96fd-379806f6c51e",
  "vulnerability_scan_id": "b72752e1-e814-4606-9275-f2ac9ca468b7",
  "os": "string",
  "authenticated": true,
  "scan_error": "string",
  "name": "string",
  "authentication_info": {
    "key1": {
      "nestedKey": "nestedValue"
    },
    "key2": [
      "listItem1",
      "listItem2"
    ],
    "key3": 42,
    "key4": null
  },
  "vulns_count": 0,
  "v0_count": 0,
  "v1_count": 0,
  "v2_count": 0,
  "v3_count": 0,
  "v4_count": 0,
  "installed_software_count": 0,
  "service_asset": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_at": "2023-12-20T00:00:01.652259Z",
    "updated_at": "2023-12-20T00:00:01.652259Z",
    "type": "Host",
    "name": "Актив",
    "description": "Описание актива",
    "coordinates": "--- []",
    "active": true,
    "scan_id": "9a59f0f5-5572-476d-a7fc-c960ef43a5af",
    "value": 3,
    "client_note": "string",
    "internal_note": "string",
    "location": "string",
    "network_exposure": 3,
    "responsible_person": "string",
    "technical_specialist": "string",
    "responsible_group_id": "2d40d7ca-3218-4132-89ef-42e29379a567",
    "edited_by": "9501acb5-3be0-4719-a60e-dfa79624666c"
  },
  "vulnerability_scan": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_at": "2023-12-20T00:00:01.652259Z",
    "updated_at": "2023-12-20T00:00:01.652259Z"
  },
  "vulnerabilities": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "created_at": "2023-12-20T00:00:01.652259Z",
      "updated_at": "2023-12-20T00:00:01.652259Z",
      "plugin_id": "8b176ba5-fa8e-458e-94ad-85d1ae8f3be0",
      "plugin_name": "string",
      "description": "string",
      "severity": 0,
      "additional_data": {},
      "protocol": "string",
      "port": 0,
      "occurrence_id": "8508ee33-23a1-4a06-ae02-1eb167405e7b",
      "synopsis": "string",
      "vulnerability_host_id": "f7091c30-f117-455e-9531-6af6bb5ece68",
      "exploitable": true,
      "plugin_output": "string",
      "solution": "string",
      "compare_port": -1,
      "compare_protocol": "",
      "service_asset_id": "09122f07-8b1e-48dc-96fd-379806f6c51e",
      "vulnerability_scan_id": "b72752e1-e814-4606-9275-f2ac9ca468b7",
      "external": false,
      "remote_exploitable": false,
      "cvss_vector": "string",
      "cvss_temporal_vector": "string",
      "cvss_base_score": 0,
      "cvss_temporal_score": 0,
      "risk_factor": "string",
      "plugin_modification_date": "string",
      "publication_date": "string"
    }
  ],
  "_relations": {
    "vulnerabilities": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }
}

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

Код	Ответ	Описание
400	id should be uuid format	Недопустимый формат ID, должен быть uuid
404	Nnot 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
}