getEndpointsList

Bitdefender-ийн албан ёсны баримтаас орчуулавАнгли эх (EN) · Орчуулсан: 2026.11.10

Энэ хуудсыг AI-аар орчуулж, автоматаар шалгасан. Нарийн тохиргоо хийхээсээ өмнө англи эхтэй тулгаж болно.

Энэ арга нь төгсгөлийн төхөөрөмжүүдийн (endpoint) жагсаалтыг буцаана.

Чухал: Энэ арга 1.1 хувилбар болж шинэчлэгдсэн. 1.0 хувилбарт хамаарах мэдээллийг доорх «Version 1.0» хэсгээс үзнэ үү.

Параметрүүд

parentId (String, заавал биш) — зорилтот компани эсвэл бүлгийн ID. Заагаагүй бол арга нь API түлхүүртэй холбогдсон компанийн зорилтот объектууд дахь зүйлсийг буцаана.

> Тэмдэглэл: Active Directory-н төгсгөлийн төхөөрөмжийн мэдээллийг авахын тулд getNetworkInventoryItems аргыг ашиглана.

isManaged (Boolean, заавал биш) — удирдлагад байгаа эсвэл байхгүй төгсгөлийн төхөөрөмжийг жагсаах тугны утга. Үндсэн байдлаар параметр тохируулаагүй бөгөөд арга нь удирдлагад байгаа болон байхгүй бүх төгсгөлийн төхөөрөмжийг буцаана. True гэж тохируулбал зөвхөн удирдлагад байгаа төгсгөлийн төхөөрөмжийг буцаана.
page (Number, заавал биш) — үр дүнгийн хуудасны дугаар. Үндсэн утга: 1.
perPage (Number, заавал биш) — буцаах нэг хуудасны зүйлийн тоо. Боломжит утга: 1 - 1000. Үндсэн утга: 30.
filters (Object, заавал биш) — авах төгсгөлийн төхөөрөмжийн төрлийг тохируулах параметрүүд. Боломжит шүүлтүүр болон хэрэглэх талаар доорх «Боломжит шүүлтүүрүүд» хэсгээс үзнэ үү.
options (Object, заавал биш) — хариуд ямар мэдээлэл багтахыг удирдах сонголтуудын багц.

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

filters параметрээр төгсгөлийн төхөөрөмжүүдийг тодорхой шинж чанараар нь лавлаж болно. Шүүлтүүрүүд хэсэг болон дэд хэсгүүдэд хуваагдсан бөгөөд доор тайлбарлав.

Лавлагааны үр дүн нь БҮХ хэсэг БОЛОН дэд хэсэгт сонгосон шүүлтүүрүүдийн АЛЬ НЬ (ANY) таарсан төгсгөлийн төхөөрөмжүүдийн жагсаалт байна.

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

security (хэсэг) → management (дэд хэсэг):

- managedWithBest — аюулгүй байдлын агент суулгасан бүх төгсгөлийн төхөөрөмжийг шүүх Boolean. Үндсэн утга: False.
- managedExchangeServers — хамгаалагдсан бүх Exchange сервер шүүх Boolean. Үндсэн утга: False. Энэ шүүлтүүр нь аюулгүй байдлын үйлчилгээг хамарсан хүчинтэй лицензийн түлхүүр шаардана.
- managedRelays — Relay үүрэгтэй бүх төгсгөлийн төхөөрөмжийг шүүх Boolean. Үндсэн утга: False.
- securityServers — бүх Security Server шүүх Boolean. Үндсэн утга: False.

depth:

- allItemsRecursively — компанийн Network Inventory доторх бүх төгсгөлийн төхөөрөмжийг рекурсив байдлаар шүүх Boolean. Үндсэн утга: False.

details:

- ssid — string, төгсгөлийн төхөөрөмжийг хамгаалалтын төлөвөөс үл хамааран шүүхэд ашиглах SSID (төгсгөлийн төхөөрөмжийн Active Directory SID).
- macs — array, төгсгөлийн төхөөрөмжийг хамгаалалтын төлөвөөс үл хамааран шүүхэд ашиглах MAC хаягуудын жагсаалт.
- name — string, төгсгөлийн төхөөрөмжийг хамгаалалтын төлөвөөс үл хамааран нэрээр нь шүүхэд ашиглана. Хамгийн багадаа гурван тэмдэгт байх ёстой.

Чухал: Зарим шүүлтүүр тусгай лиценз идэвхтэй байхыг шаарддаг. Үгүй бол тэдгээрийг үл тооно, улмаар API-ийн хариу буруу гарна.

name талбар хэсэгчлэн таарах байдлаар ажилладаг.

Шүүлтүүр нь нэр нь заасан утгатай яг таарсан эсвэл тэр утгаар эхэлсэн төгсгөлийн төхөөрөмжүүдийг буцаана. Заасан утгыг дараалал (suffix) болгон ашиглахын тулд од (*) тэмдэг хэрэглэнэ.

Жишээ нь:

name нь computer бол API нь нэр нь computer-ээр эхэлсэн бүх төгсгөлийн төхөөрөмжийг буцаана.

name нь *puter бол API нь нэрэндээ puter агуулсан бүх төгсгөлийн төхөөрөмжийн жагсаалтыг буцаана.

Боломжит сонголтууд

options параметрээр API-ийн хариуд ямар мэдээлэл багтахыг тохируулна. Сонголтууд хэсэг, дэд хэсгүүдэд хуваагдсан бөгөөд доор тайлбарлав.

Боломжит сонголтууд:

returnProductOutdated — Boolean. true бол API-ийн хариунд productOutdated атрибут орно.
includeScanLogs — Boolean. true бол API-ийн хариунд lastSuccessfulScan атрибут орно. Үндсэн утга: false.

Буцаах утга

Энэ арга төгсгөлийн төхөөрөмжүүдийн талаарх мэдээллийг агуулсан Object буцаана. Буцсан объект дараахыг агуулна:

page - одоо харуулж буй хуудасны дугаар.

pagesCount - нийт хуудасны тоо.

> Тэмдэглэл: Энэ атрибут зөвхөн 1-р хуудсанд харагдана.

perPage - нэг хуудсанд харуулсан зүйлийн нийт тоо.

total - хүсэлтийн буцаасан зүйлийн нийт тоо.

> Тэмдэглэл: Энэ атрибут зөвхөн 1-р хуудсанд харагдана.

hasMoreRecords - Boolean, дараагийн хуудсанд өөр бичлэг байгаа эсэхийг заана.

items - төгсгөлийн төхөөрөмжүүдийн жагсаалт агуулсан массив. Жагсаалтын бичлэг бүр дараах талбаруудтай:

- id, удирдлагад байгаа төгсгөлийн төхөөрөмжийн ID,
- name, төгсгөлийн төхөөрөмжийн нэр,
- label, энэ төгсгөлийн төхөөрөмжид оноосон шошго,
- fqdn, төгсгөлийн төхөөрөмжийн FQDN,
- groupId, төгсгөлийн төхөөрөмжийн бүлгийн ID,
- isManaged, boolean, төгсгөлийн төхөөрөмж удирдлагад байгаа бол True,
- machineType, машины төрөл: (1 - компьютер, 2 - виртуал машин, 3 - EC2 Instance, 0 - бусад),
- operatingSystemVersion, төгсгөлийн төхөөрөмжийн үйлдлийн системийн хувилбар,
- firstSeen - төгсгөлийн төхөөрөмж GravityZone-д анх бүртгэгдсэн эсвэл илэрсэн цагийг заасан String,
- isIsolated - төгсгөлийн төхөөрөмж одоогоор тусгаарлах үйлдлээр сүлжээнээс тусгаарлагдсан эсэхийг заасан Boolean,
- ip, төгсгөлийн төхөөрөмжийн локал IP хаяг,
- publicIp, төгсгөлийн төхөөрөмжийн олон нийтийн (public) IP хаяг,
- macs, төгсгөлийн төхөөрөмжийн MAC хаягууд,
- ssid, төгсгөлийн төхөөрөмжийн SSID (Active Directory SID),
- managedWithBest, boolean, төгсгөлийн төхөөрөмж дээр BEST суулгасан бол True,
- isContainerHost, boolean, төгсгөлийн төхөөрөмж Container Host бол True,
- managedExchangeServer, boolean, төгсгөлийн төхөөрөмж Exchange Server бол True,
- managedRelay, boolean, төгсгөлийн төхөөрөмж Relay үүрэгтэй бол True,
- securityServer, boolean, төгсгөлийн төхөөрөмж Security Server бол True,
- policy, төгсгөлийн төхөөрөмж дээрх идэвхтэй бодлогыг заасан Object. Дараах талбаруудтай:
- id - идэвхтэй бодлогыг өвөрмөц тодорхойлох String,
- name - бодлогын нэр,
- applied - бодлого одоогоор төгсгөлийн төхөөрөмж дээр хэрэгжиж байвал True болсон Boolean,
- movingInfo, төгсгөлийн төхөөрөмжийг нэг компаниас нөгөө рүү шилжүүлж буй тухай Object. Дараахыг агуулна:
- state - төгсгөлийн төхөөрөмжийн зөөлтийн төлөв (0 - явагдаж байна, 1 - зөөгдсөн),
- destinationCompanyName - төгсгөлийн төхөөрөмж зөөгдсөн компанийн нэр.
- productOutdated, boolean, төгсгөлийн төхөөрөмж агентын нэг буюу хэд хэдэн шинэчлэлтийг аваагүй бол True.
- lastSuccessfulScan, object. Дараах мэдээллийг агуулна:
- name - шалгалтын нэр.
- date - шалгалт хийсэн огноо.

Жишээ

Хүсэлт:

{
      "params": {
           "parentId": "63c6bb02e3cb799758020b99",
           "page": 1,
           "perPage": 3,
           "filters": {
                   "security": {
                            "management": {
                                "managedWithBest": true,
                                "managedRelays": true
				}
                   }
		},
           "options": {
                   "returnProductOutdated": true,
                   "includeScanLogs": true
           }
      },
      "jsonrpc": "2.0",
      "method": "getEndpointsList",
      "id": "301f7b05-ec02-481b-9ed6-c07b97de2b7b"
}

Хариу:

{
  "result": {
    "total": 8,
    "page": 1,
    "perPage": 3,
    "pagesCount": 3,
    "hasMoreRecords": true,
    "items": [
      {
        "id": "64b7625d3c11463ef77e5d6d",
        "name": "string00:16:3e:7f:d3:2e",
        "label": "",
        "fqdn": "s0lc5.wkorh.dsd.ro",
        "groupId": "64b503c21ecee42e130a7bc9",
        "isManaged": true,
        "machineType": 1,
        "operatingSystemVersion": "Windows 7 Professional",
        "firstSeen": "2026-08-15T10:30:00",
        "isIsolated": false,
        "ip": "231.180.244.114",
        "publicIp": "203.0.113.185",
        "macs": [
          "00:16:3e:7f:d3:2e"
        ],
        "ssid": "",
        "managedWithBest": true,
        "policy": {
          "id": "64b76bed92f0176fa203b64c",
          "name": "New Policy",
          "applied": false
        },
        "productOutdated": false,
        "lastSuccessfulScan": {
          "name": "72OHI5dnIH",
          "date": "2023-07-19T04:09:29+00:00"
        }
      }
    ]
  },
  "jsonrpc": "2.0",
  "id": "5986",
  "error": null
}

{
  "result": {
    "page": 2,
    "perPage": 3,
    "hasMoreRecords": true,
    "items": [
      {
       ...
      }
    ]
  },
  "jsonrpc": "2.0",
  "id": "5986",
  "error": null
}

Version 1.0