getQuarantineItemsList

Энэ арга нь компанид хамаарах хориод (quarantine) орсон зүйлсийн жагсаалтыг буцаана.

Зүйл нь файл эсвэл Microsoft Exchange объект байж болно.

Үйлчилгээнүүд

Энэ арга нь API URL-д {service} нэрийг оруулахыг шаарддаг. Зөвшөөрөгдсөн үйлчилгээнүүд:

• computers — "Computers and Virtual Machines"
• exchange — "Security for Exchange"

Жишээ нь exchange үйлчилгээний хүсэлтийн URL:

https://YOUR-HOSTNAME/api/v1.0/jsonrpc/quarantine/exchange

Параметрүүд

• endpointId (String, заавал биш) — хориод орсон зүйлсийг авах компьютерийн ID. Хүсэлтэд энэ параметрийг оруулаагүй бол арга нь сүлжээ даяар хорионд орсон зүйлсийг буцаана.
• page (Number, заавал биш) — үр дүнгийн хуудас. Үндсэн утга нь 1.
• perPage (Number, заавал биш) — нэг хуудсанд харуулах зүйлсийн тоо. Дээд хязгаар нь нэг хуудсанд 100 зүйл. Үндсэн утга нь нэг хуудсанд 30 зүйл.
• filters (Object, заавал биш) — хорионы жагсаалтыг лавлахад ашиглах шүүлтүүрүүд. Боломжит шүүлтүүр болон тэдгээрийг хэрхэн ашиглах талаар Боломжит шүүлтүүрүүд хэсгээс үзнэ үү.

Боломжит шүүлтүүрүүд

filters параметрийг ашиглан хорионыг тодорхой шинж чанараар лавлаж болно.

Лавлагааны үр дүн нь сонгосон БҮХ шүүлтүүрт таарсан хориод орсон зүйлсийн жагсаалт байна.

Шүүлтүүрийн сонголтууд:

• threatName (String) — хориод орсон зүйлсийг аюулын нэрээр шүүнэ. Энэ шүүлтүүр computers болон exchange үйлчилгээнд боломжтой.
• startDate (String) — заасан огнооноос хойш хорионд орсон зүйлсийг шүүнэ. startDate-ийн формат нь ISO 8601. Энэ шүүлтүүр computers болон exchange үйлчилгээнд боломжтой.
• endDate (String) — заасан огнооноос өмнө хорионд орсон зүйлсийг шүүнэ. endDate-ийн формат нь ISO 8601. Энэ шүүлтүүр computers болон exchange үйлчилгээнд боломжтой.
• filePath (String) — хориод орсон зүйлсийг файлын замаар шүүнэ. Энэ шүүлтүүр computers үйлчилгээнд боломжтой.
• fileSha256 (String) — хориод орсон зүйлсийг файлын хэш (hash)-ээр шүүнэ. Энэ шүүлтүүр computers үйлчилгээнд боломжтой.
• ip (String) — хориод орсон зүйлсийг IP хаягаар шүүнэ. Энэ шүүлтүүр computers үйлчилгээнд боломжтой.
• actionStatus (Integer) — хориод орсон зүйлсийг үйлдлийн төлвөөр шүүнэ. actionStatus-ийн боломжит утгууд:

- 0 - None (байхгүй)
- 1 - Pending remove (устгахыг хүлээж байна)
- 2 - Pending restore (сэргээхийг хүлээж байна)
- 3 - Remove failed (устгаж чадсангүй)
- 4 - Restore failed (сэргээж чадсангүй)

Үйлчилгээ нь exchange бол дараах үйлдлийн төлвүүд бас хүчинтэй:
- 16 - Pending Save (хадгалахыг хүлээж байна)
- 17 - Failed Save (хадгалж чадсангүй)

Энэ шүүлтүүр computers болон exchange үйлчилгээнд боломжтой.

Буцаах утга

Энэ арга нь хориод орсон зүйлсийн объектуудыг агуулсан Array буцаана. Массив дахь бичлэг бүр дараах бүтэцтэй:

• page - одоо харагдаж буй хуудас

• pagesCount - боломжит хуудасны нийт тоо

• perPage - нэг хуудсанд буцаасан зүйлсийн нийт тоо

• total - зүйлсийн нийт тоо

• items - хориод орсон зүйлсийн жагсаалт. Жагсаалтын бичлэг бүр дараах талбаруудтай:

- id, хориод орсон зүйлийн ID
- quarantinedOn, объект хорионд орсон огноо, цаг
- actionStatus, хориод орсон файл дээр хийсэн үйлдлийн төлөв: (0 - None; 1 - Pending remove; 2 - Pending restore; 3 - Remove failed; 4 - Restore failed; 16 - Pending save; 17 - Failed save)
- endpointId, аюул илэрсэн endpoint-ийн ID
- endpointName, аюул илэрсэн endpoint-ийн нэр
- endpointIP, аюул илэрсэн endpoint-ийн IP
- canBeRestored, сэргээх үйлдлийг зөвшөөрсөн бол True, үгүй бол False утгатай.
- companyId, компанийн ID
- details, хориод орсон зүйлтэй холбоотой нэмэлт мэдээлэл. details талбарын агуулгын талаар details-ийн агуулга хэсгээс үзнэ үү.

details-ийн агуулга

Computers and Virtual Machines үйлчилгээний хувьд details талбар дараах бүтэцтэй:

• filePath (String) — endpoint дээр аюул илэрсэн халдвартай эсвэл сэжигтэй файлын зам.
• fileSha256 (String) — хориод орсон файлын хэш.

Security for Exchange үйлчилгээний хувьд details талбар дараах бүтэцтэй:

• detectionPoint (Integer) — илрүүлэлт хийгдсэн түвшин. Боломжит утгууд:

- 0 - transport
- 1 - mailbox
- 2 - folder
- 3 - on demand

• itemType (Integer) — хориод орсон объектын төрөл. Боломжит утгууд:

- 0 - attachment (хавсралт)
- 1 - email (и-мэйл)

• threatStatus (String) — шалгалт (scan) дууссан үеийн объектын төлөв. Энэ төлөв нь и-мэйл спам эсвэл хүсээгүй агуулгатай эсэх, хавсралт хортой программаар халдварласан, халдварласан гэж сэжиглэгдсэн, хүсээгүй эсвэл шалгах боломжгүй эсэхийг харуулна. Боломжит утгууд:

- 0 - spam
- 1 - suspected
- 2 - infected
- 3 - attachment detection
- 4 - content detection
- 5 - unscannable

• email (Object) —

- senderIP, илгээгчийн IP хаягийг агуулсан String
- senderEmail, и-мэйлийн толгойн fieldFrom талбарт харагдах илгээгчийн и-мэйл хаягийг агуулсан String
- subject, хориод орсон и-мэйлийн гарчиг агуулсан String
- recipients, и-мэйлийн толгойн To болон Cc талбарт харагдах хүлээн авагчдыг агуулсан Array
- realRecipients, зорьсон хүлээн авагчдын и-мэйл хаягийг агуулсан Array

Жишээ

Хүсэлт:

     {
         "params": {
             
             "endpointId": "5d36c255f23f730fa91944e2",
             "page": 2,
             "perPage": 1,
             "filters": {
                 "threatName": "Virus 0",
                 "actionStatus": 1,
                 "startDate": "2019-07-28T11:31:28",
                 "endDate": "2019-08-16T11:31:16",
                 "filePath": "c:\\Virus0\\virus0.exe",
                 "fileSha256": "5d41402abc4b2a76b9719d911017c592"
             }
         },
         "jsonrpc": "2.0",
         "method": "getQuarantineItemsList",
         "id": "5399c9b5-0b46-45e4-81aa-889952433d86"
     }

Хариу:

This response example is for computers service:
   {
         "id": "5399c9b5-0b46-45e4-81aa-889952433d86",
         "jsonrpc": "2.0",
         "result": {
             "total": 2,
             "page": 2,
             "perPage": 1,
             "pagesCount": 2,
             "items": [
                 {
                     "id": "5d3968e0f23f730ecb0f68c2",
                     "quarantinedOn": "2019-07-28T11:31:28",
                     "actionStatus": 1,
                     "companyId": "55896b87b7894d0f367b23c6",
                     "endpointId": "5d36c255f23f730fa91944e2",
                     "endpointName": "Computer 1",
                     "endpointIP": "156.133.37.181",
                     "canBeRestored": false,
                     "canBeRemoved": false,
                     "threatName": "Virus 0",
                     "details": {
                         "filePath": "c:\\Virus0\\virus0.exe",
                         "fileSha256": "5d41402abc4b2a76b9719d911017c592"
                     }
                 }
             ]
         }
     }

This response example is for exchange service:
     {
         "id": "5399c9b5-0b46-45e4-81aa-889952433d86",
         "jsonrpc": "2.0",
         "result": {
             "page": 2,
             "pagesCount": 10,
             "perPage": 1,
             "total": 10,
             "items": [{
                   "id": "5b7d219bb1a43d170b7b23ee",
                   "quarantinedOn": "2019-08-01T07:15:20",
                   "actionStatus": 1,
                   "endpointId": "5d36c255f23f730fa91944e2",
                   "endpointName": "Computer 1",
                   "endpointIP": "57.238.160.118",
                   "endpointAvailable": true,
                   "threatName": "Virus 0",
                   "companyId": "55896b87b7894d0f367b23c6",
                   "details": {
                       "threatStatus": 4,
                       "itemType" : 0,
                       "detectionPoint": 1,
                       "email": {
                           "senderIP": "185.36.136.238",
                           "senderEmail": "test@test.com",
                           "subject":
                         "Test subject_5b7d2128b1a43da20c7b23c6",
                           "recipients": [
                              "receiver1@test.com",
                              "receiver2@test.com"
                           ],
                           "realRecipients": [
                              "receiver1@test.com",
                              "receiver2@test.com"
                          ]
                       }
                   }
               }]
          }
     }