getEndpointTags

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

Параметрүүд

• orderBy (String, заавал биш) — буцаах шошгуудыг эрэмбэлэх шалгуур.

- name: шошгыг нэрээр нь эрэмбэлнэ.
- type: шошгыг төрлөөр нь эрэмбэлнэ: Custom эсвэл Automatic.
- created: шошгыг үүсгэсэн огноогоор нь эрэмбэлнэ.
- Үндсэн утга: created.
- Жишээ: "orderBy": "name"

• order (String, заавал биш) — эрэмбийн чиглэл.

- ASC: сонгосон шалгуурын дагуу өсөхөөр буцаана. created: хамгийн эхнийхээс сүүлийнх рүү. name: A-аас Z хүртэл цагаан толгойн дарааллаар. type: Custom шошго Automatic шошгын өмнө.
- DESC: сонгосон шалгуурын дагуу буурахаар буцаана. created: хамгийн сүүлийнхээс эхнийх рүү. name: Z-ээс A хүртэл. type: Automatic шошго Custom шошгын өмнө.
- Үндсэн утга: DESC.
- Жишээ: "order": "ASC"

Ерөнхий параметрүүд

Эдгээр нь нийтийн API-ийн бүх аргад нийтлэг параметрүүд юм.

• id (String, хүсэлтэд заавал) — хүсэлтийг хариутай нь холбох таниулагч. Хүлээн авагч хариундаа ижил утгыг буцаадаг тул дуудлагыг хялбар мөрдөнө. Нэмэлт шаардлага байхгүй. Жишээ: "id": "ad12cb61-52b3-4209-a87a-93a8530d91cb"
• method (String, хүсэлтэд заавал) — хүсэлт илгээхэд ашиглаж буй аргын нэр. Хүчинтэй аргын нэр байх ёстой. Жишээ: "method": "methodName"
• jsonrpc (String, хүсэлтэд заавал) — хүсэлт болон хариуд ашиглах JSON-RPC-ийн хувилбар. Цорын ганц боломжит утга нь 2.0. Жишээ: "jsonrpc": "2.0"
• params (Object, хүсэлтэд заавал) — хүсэлтийн тохиргоог агуулсан объект. Нэмэлт шаардлага байхгүй. Жишээ: "params": {...}

params объект доторх параметрүүд:

• page (Integer, заавал биш) — үр дүнгийн хуудасны дугаар. Үндсэн утга: 1. Жишээ: "page": 2
• perPage (Integer, заавал биш) — нэг хуудсанд харуулах үр дүнгийн тоо. Дээд хязгаар нь нэг хуудсанд 100. Үндсэн утга: 30. Жишээ: "perPage": 1

Буцаах утга

• result (Array of objects) — таны компани доторх төгсгөлийн төхөөрөмжийн шошгуудын мэдээлэл. Массив доторх объект бүрийн талаар доорх result хэсгээс үзнэ үү.

Объектууд

result

• id (String) — төгсгөлийн төхөөрөмжийн шошгын ID.

> Зөвлөгөө: Энэ ID-г createCustomRule, updateCustomRule аргуудад ашиглан, энэ шошготой төгсгөлийн төхөөрөмжүүдийг онилсон өөрийн дүрэм (custom rule) тохируулж болно.

• name (String) — шошгын нэр.
• type (Integer) — шошгын төрөл. Боломжит утгууд: 0: Custom шошго; 1: Automatic шошго.
• description (String) — шошгын тайлбар.
• company (Object) — шошготой холбоотой компанийн мэдээлэл. Объект нь id (String, компанийн ID) болон name (String, компанийн нэр)-ийг агуулна.
• created (String) — шошгыг үүсгэсэн огноо, цаг.
• rules (Object) — Automatic шошгыг тодорхойлоход ашиглах дүрмүүд. Объект дараахыг агуулна:

- endpointName (Object) — төгсгөлийн төхөөрөмжийн нэрийн хэв маягийн дүрмийн мэдээлэл. Доорх endpointName хэсгийг үзнэ үү.
- ip (Object) — IP эсвэл CIDR-ийн дүрмийн мэдээлэл. Доорх ip хэсгийг үзнэ үү.
- os (Object) — үйлдлийн системийн төрлийн дүрмийн мэдээлэл. Доорх os хэсгийг үзнэ үү.
- endpointType (Object) — төгсгөлийн төхөөрөмжийн төрлийн дүрмийн мэдээлэл. Доорх endpointType хэсгийг үзнэ үү.

endpointName

• enabled (Boolean) — дүрэм шошгын тодорхойлолтод идэвхтэй эсэхийг заана: true бол идэвхтэй, false бол идэвхгүй.
• rule (String) — энэ шошгыг авахын тулд төгсгөлийн төхөөрөмжийн нэр таарах ёстой хэв маяг. * болон ? орлуулагч тэмдэгтийг дэмжинэ.

> Чухал: enabled атрибутын утга false бол rule нь null биш байсан ч шошгын ажиллагаанд нөлөөлөхгүй.

ip

• enabled (Boolean) — дүрэм шошгын тодорхойлолтод идэвхтэй эсэхийг заана: true бол идэвхтэй, false бол идэвхгүй.
• rule (String) — энэ шошгыг авахын тулд төгсгөлийн төхөөрөмж таарах ёстой IP хаяг эсвэл CIDR муж.

> Чухал: enabled атрибутын утга false бол rule нь null биш байсан ч шошгын ажиллагаанд нөлөөлөхгүй.

os

• enabled (Boolean) — дүрэм шошгын тодорхойлолтод идэвхтэй эсэхийг заана: true бол идэвхтэй, false бол идэвхгүй.
• rule (Integer) — энэ шошгыг авахын тулд төгсгөлийн төхөөрөмж ажиллуулж буй үйлдлийн систем. Боломжит утгууд: 3: Windows; 4: Linux; 6: macOS.

> Чухал: enabled атрибутын утга false бол rule нь null биш байсан ч шошгын ажиллагаанд нөлөөлөхгүй.

endpointType

• enabled (Boolean) — дүрэм шошгын тодорхойлолтод идэвхтэй эсэхийг заана: true бол идэвхтэй, false бол идэвхгүй.
• rule (Integer) — энэ шошгыг авахад шаардлагатай төгсгөлийн төхөөрөмжийн төрөл. Боломжит утгууд: 0: Workstation; 1: Server.

> Чухал: enabled атрибутын утга false бол rule нь null биш байсан ч шошгын ажиллагаанд нөлөөлөхгүй.

Жишээ

Хүсэлт:

{
    "id": "7d2864e9-c67b-48a2-9ba3-0a11d47e83c8",
    "jsonrpc": "2.0",
    "method": "getEndpointTags",
    "params": {
        "page": 1,
        "perPage": 30,
        "orderBy": "name",
        "order": "ASC"
    }
}

Хариу:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "id": "6a1823963501cd2e0306f605",
            "name": "Production Servers",
            "type": 0,
            "description": "All production server endpoints",
            "company": {
                "id": "66a0fe708d3a52774522b111",
                "name": "Acme Corp"
            },
            "created": "2026-03-15T09:42:00+00:00"
        },
        {
            "id": "6a1823963501cd2e0306f609",
            "name": "Windows Workstations",
            "type": 1,
            "description": "Automatic tag for Windows workstations",
            "company": {
                "id": "66a0fe708d3a52774522b111",
                "name": "Acme Corp"
            },
            "created": "2026-02-10T14:00:00+00:00",
            "rules": {
                "endpointName": {
                    "enabled": false,
                    "rule": "WIN-*"
                },
                "ip": {
                    "enabled": false,
                    "rule": null
                },
                "os": {
                    "enabled": true,
                    "rule": 3
                },
                "endpointType": {
                    "enabled": true,
                    "rule": 0
                }
            }
        }
    ],
    "id": "7d2864e9-c67b-48a2-9ba3-0a11d47e83c8"
}