Referenční informace k rozhraní API pro správu inventáře pro senzory monitorování OT

Článek
12/18/2023

Tento článek obsahuje seznam rozhraní API pro správu inventáře zařízení podporovaná pro senzory OT Defenderu pro IoT.

připojení (načtení informací o připojení zařízení)

Toto rozhraní API slouží k vyžádání seznamu všech připojení zařízení.

Identifikátor URI: /api/v1/devices/connections

GET

Parametry dotazů

Definujte některý z následujících parametrů dotazu pro filtrování vrácených výsledků. Pokud nenastavíte parametry dotazu, vrátí se všechna připojení zařízení.

Název	Popis	Příklad	Povinné nebo volitelné
zjištěnábefore	Číselné. Výsledky filtrování, které byly zjištěny před daným časem, kde se daný čas definuje v milisekundách od epochy a v časovém pásmu UTC.	`/api/v1/devices/2/connections?discoveredBefore=<epoch>`	Volitelné
discoveredAfter	Číselné. Výsledky filtrování, které byly zjištěny po daném čase, kde se daný čas definuje v milisekundách od epochy a v časovém pásmu UTC.	`/api/v1/devices/2/connections?discoveredAfter=<epoch>`	Volitelné
lastActiveInMinutes	Číselné. Výsledky můžete filtrovat podle daného časového rámce, během kterého byla připojení aktivní. Definováno zpětně v minutách od aktuálního času.	`/api/v1/devices/2/connections?lastActiveInMinutes=20`	Volitelné

Typ odpovědi: JSON

Pole objektů JSON, které představují připojení zařízení, nebo následující chybová zpráva:

Message	Popis
Selhání – chyba	Operace selhala.

Pole odpovědi na úspěch

Name	Type	Nullable / Not nullable	Seznam hodnot
firstDeviceId	Číslo	Nelze použít hodnotu null.	-
secondDeviceId	Číslo	Nelze použít hodnotu null.	-
lastSeen	Číslo	Nelze použít hodnotu null.	Epocha (UTC)
Objevil	Číslo	Nelze použít hodnotu null.	Epocha (UTC)
Porty	Číselné pole	S možnou hodnotou Null	-
Protokoly	Pole JSON	S možnou hodnotou Null	Pole Protokol

Pole protokolu

Name	Type	Nullable / Not nullable
Jméno	String	Nelze použít hodnotu null.
Příkazy	Pole řetězců	S možnou hodnotou Null

Příklad odpovědi

[
    {
        "firstDeviceId": 171,
        "secondDeviceId": 22,
        "lastSeen": 1511281457933,
        "discovered": 1511872830000,
        "ports": [
            502
        ],
        "protocols": [
        {
            name: "modbus",
            commands: [
                "Read Coils"
            ]
        },
        {
            name: "ams",
            commands: [
                "AMS Write"
            ]
        },
        {
            name: "http",
            commands: [
            ]
        }
    ]
    },
    {
        "firstDeviceId": 171,
        "secondDeviceId": 23,
        "lastSeen": 1511281457933,
        "discovered": 1511872830000,
        "ports": [
            502
        ],
        "protocols": [
            {
                name: "s7comm",
                commands: [
                    "Download block",
                    "Upload"
                ]
            }
        ]
    }
]

Typ: GET

Rozhraní API:

curl -k -H "Authorization: <AUTH_TOKEN>" https://<IP_ADDRESS>/api/v1/devices/connections

Příklady:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" https://127.0.0.1/api/v1/devices/connections

připojení na zařízení (načtení konkrétních informací o připojení zařízení)

Toto rozhraní API slouží k vyžádání seznamu všech připojení na zařízení.

Identifikátor URI: /api/v1/devices/<deviceID>/connections

GET

Parametr cesty

Název	Popis	Příklad	Povinné nebo volitelné
Deviceid	Získejte připojení pro dané zařízení.	`/api/v1/devices/<deviceId>/connections`	Požaduje se

Parametry dotazů

Název	Popis	Příklad	Povinné nebo volitelné
zjištěnábefore	Číselné. Výsledky filtrování, které byly zjištěny před daným časem, kde se daný čas definuje v milisekundách od epochy a v časovém pásmu UTC.	`/api/v1/devices/2/connections?discoveredBefore=<epoch>`	Volitelné
discoveredAfter	Číselné. Výsledky filtrování, které byly zjištěny po daném čase, kde se daný čas definuje v milisekundách od epochy a v časovém pásmu UTC.	`/api/v1/devices/2/connections?discoveredAfter=<epoch>`	Volitelné
lastActiveInMinutes	Číselné. Výsledky můžete filtrovat podle daného časového rámce, během kterého byla připojení aktivní. Definováno zpětně v minutách od aktuálního času.	`/api/v1/devices/2/connections?lastActiveInMinutes=20`	Volitelné

Typ odpovědi: JSON

Pole objektů JSON, které představují připojení zařízení, nebo následující chybová zpráva:

Message	Popis
Selhání – chyba	Operace selhala.

Pole odpovědi na úspěch

Name	Type	Nullable / Not nullable	Seznam hodnot
firstDeviceId	Číslo	Nelze použít hodnotu null.	-
secondDeviceId	Číslo	Nelze použít hodnotu null.	-
lastSeen	Číslo	Nelze použít hodnotu null.	Epocha (UTC)
Objevil	Číslo	Nelze použít hodnotu null.	Epocha (UTC)
Porty	Číselné pole	S možnou hodnotou Null	-
Protokoly	Pole JSON	S možnou hodnotou Null	Pole Protokol

Pole protokolu

Name	Type	Nullable / Not nullable
Jméno	String	Nelze použít hodnotu null.
Příkazy	Pole řetězců	S možnou hodnotou Null

Příklad odpovědi

[
    {
        "firstDeviceId": 171,
        "secondDeviceId": 22,
        "lastSeen": 1511281457933,
        "discovered": 1511872830000,
        "ports": [
            502
        ],
        "protocols": [
        {
            name: "modbus",
            commands: [
                "Read Coils"
            ]
        },
        {
            name: "ams",
            commands: [
                "AMS Write"
            ]
        },
        {
            name: "http",
            commands: [
            ]
        }
    ]
    },
    {
        "firstDeviceId": 171,
        "secondDeviceId": 23,
        "lastSeen": 1511281457933,
        "discovered": 1511872830000,
        "ports": [
            502
        ],
        "protocols": [
            {
                name: "s7comm",
                commands: [
                    "Download block",
                    "Upload"
                ]
            }
        ]
    }
]

Typ: GET

Rozhraní API:

curl -k -H "Authorization: <AUTH_TOKEN>" 'https://<IP_ADDRESS>/api/v1/devices/<deviceId>/connections?lastActiveInMinutes=&discoveredBefore=&discoveredAfter=

Příklady:

S danými parametry dotazu:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" 'https://127.0.0.1/api/v1/devices/2/connections?lastActiveInMinutes=20&discoveredBefore=1594550986000&discoveredAfter=1594550986000

cves (Načtení informací o CVEs)

Toto rozhraní API slouží k vyžádání seznamu všech známých cves zjištěných na zařízeních v síti seřazených sestupně podle skóre CVE.

Identifikátor URI: /api/v1/devices/cves

GET

Příklad: /api/v1/devices/cves

Definujte některý z následujících parametrů dotazu pro filtrování vrácených výsledků.

Název	Popis	Příklad	Povinné nebo volitelné
Top	Číselné. Určete, kolik vysoce hodnocených CVE se má získat pro každou IP adresu zařízení.	`/api/v1/devices/cves?top=50` `/api/v1/devices/<ipAddress>/cves?top=50`	Nepovinné. Výchozí = `100`

Typ: JSON

Pole JSON objektů CVE zařízení nebo následující chybová zpráva:

Message	Popis
Selhání – chyba	Operace selhala.

Pole odpovědi na úspěch

Name	Type	Nullable / Not nullable	Seznam hodnot
cveId	String	Nelze použít hodnotu null.	Kanonické standardní ID pro danou CVE.
ipAddress	String	Nelze použít hodnotu null.	Adresy IP
Skóre	String	Nelze použít hodnotu null.	Skóre CVE mezi 0,0 – 10,0
attackVector	String	Nelze použít hodnotu null.	`Network`, `Adjacent Network`, `Local`nebo `Physical`
Popis	String	Nelze použít hodnotu null.	-

Příklad odpovědi

[
    {

        "cveId": "CVE-2007-0099",
        "score": "9.3",
        "ipAddress": "10.35.1.51",
        "attackVector": "NETWORK",
        "description": "Race condition in the msxml3 module in Microsoft XML Core
        Services 3.0, as used in Internet Explorer 6 and other
        applications, allows remote attackers to execute arbitrary
        code or cause a denial of service (application crash) via many
        nested tags in an XML document in an IFRAME, when synchronous
        document rendering is frequently disrupted with asynchronous
        events, as demonstrated using a JavaScript timer, which can
        trigger NULL pointer dereferences or memory corruption, aka
        \"MSXML Memory Corruption Vulnerability.\""
    },
    {
        "cveId": "CVE-2009-1547",
        "score": "9.3",
        "ipAddress": "10.35.1.51",
        "attackVector": "NETWORK",
        "description": "Unspecified vulnerability in Microsoft Internet Explorer 5.01
        SP4, 6, 6 SP1, and 7 allows remote attackers to execute
        arbitrary code via a crafted data stream header that triggers
        memory corruption, aka \"Data Stream Header Corruption
        Vulnerability.\""
    }
]

Typ: GET

Rozhraní API:

curl -k -H "Authorization: <AUTH_TOKEN>" https://<IP_ADDRESS>/api/v1/devices/cves

Příklady:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" https://127.0.0.1/api/v1/devices/cves

Cves na IP adresu (Načtení konkrétních informací o CVEs)

Toto rozhraní API slouží k vyžádání seznamu všech známých cves zjištěných na zařízeních v síti pro konkrétní IP adresu.

Identifikátor URI: /api/v1/devices/cves

GET

Příklad: /api/v1/devices/cves

Parametr cesty

Název	Popis	Příklad	Povinné nebo volitelné
ipAddress	Získejte cves pro danou IP adresu.	`/api/v1/devices/<ipAddress>/cves`	Požaduje se

Definujte následující parametr dotazu pro filtrování vrácených výsledků.

Název	Popis	Příklad	Povinné nebo volitelné
Top	Číselné. Určete, kolik vysoce hodnocených CVE se má získat pro každou IP adresu zařízení.	`/api/v1/devices/cves?top=50` `/api/v1/devices/<ipAddress>/cves?top=50`	Nepovinné. Výchozí = `100`

Typ: JSON

Pole JSON objektů CVE zařízení nebo následující chybová zpráva:

Message	Popis
Selhání – chyba	Operace selhala.

Pole odpovědi na úspěch

Name	Type	Nullable / Not nullable	Seznam hodnot
cveId	String	Nelze použít hodnotu null.	Kanonické standardní ID pro danou CVE.
ipAddress	String	Nelze použít hodnotu null.	Adresy IP
Skóre	String	Nelze použít hodnotu null.	Skóre CVE mezi 0,0 – 10,0
attackVector	String	Nelze použít hodnotu null.	`Network`, `Adjacent Network`, `Local`nebo `Physical`
Popis	String	Nelze použít hodnotu null.	-

Příklad odpovědi

[
    {

        "cveId": "CVE-2007-0099",
        "score": "9.3",
        "ipAddress": "10.35.1.51",
        "attackVector": "NETWORK",
        "description": "Race condition in the msxml3 module in Microsoft XML Core
        Services 3.0, as used in Internet Explorer 6 and other
        applications, allows remote attackers to execute arbitrary
        code or cause a denial of service (application crash) via many
        nested tags in an XML document in an IFRAME, when synchronous
        document rendering is frequently disrupted with asynchronous
        events, as demonstrated using a JavaScript timer, which can
        trigger NULL pointer dereferences or memory corruption, aka
        \"MSXML Memory Corruption Vulnerability.\""
    },
    {
        "cveId": "CVE-2009-1547",
        "score": "9.3",
        "ipAddress": "10.35.1.51",
        "attackVector": "NETWORK",
        "description": "Unspecified vulnerability in Microsoft Internet Explorer 5.01
        SP4, 6, 6 SP1, and 7 allows remote attackers to execute
        arbitrary code via a crafted data stream header that triggers
        memory corruption, aka \"Data Stream Header Corruption
        Vulnerability.\""
    }
]

Typ: GET

Rozhraní API:

curl -k -H "Authorization: <AUTH_TOKEN>" https://<IP_ADDRESS>/api/v1/devices/<deviceIpAddress>/cves?top=

Příklady:

S danými parametry dotazu:

curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" https://127.0.0.1/api/v1/devices/10.10.10.15/cves?top=50

zařízení (načtení informací o zařízení)

Toto rozhraní API slouží k vyžádání seznamu všech zařízení zjištěných tímto senzorem.

Identifikátor URI: api/v1/devices/

GET

Parametr dotazu

Definujte následující parametr dotazu pro filtrování vrácených výsledků. Pokud nenastavíte parametry dotazu, vrátí se všechna připojení zařízení.

Název	Popis	Příklad	Povinné nebo volitelné
Autorizovaný	Boolean: - `true`: Filtrujte data jenom na autorizovaných zařízeních. - `false`: Filtrujte data pouze na neautorizovaných zařízeních.	`/api/v1/devices/`	Volitelné

Typ odpovědi: JSON

Pole objektů JSON, které představují objekty zařízení, nebo následující chybová zpráva:

Message	Popis
Selhání – chyba	Operace selhala.

Pole odpovědi na úspěch

Name	Type	Nullable / Not nullable	Seznam hodnot
id	Číselné. Definuje ID zařízení.	Nelze použít hodnotu null.	-
ipAddresses	Pole JSON řetězců	S možnou hodnotou Null	-
Jméno	Řetězec. Definuje název zařízení.	Nelze použít hodnotu null.	-
Dodavatele	Řetězec. Definuje dodavatele zařízení.	S možnou hodnotou Null	-
Operatingsystem	Výčtu. Definuje operační systém zařízení.	S možnou hodnotou Null	Další informace naleznete v tématu Podporované hodnoty operačního systému.
macAddresses	Pole JSON řetězců	S možnou hodnotou Null	-
type	Řetězec. Definuje typ zařízení.	Nelze použít hodnotu null.	Může to být `Unknown`. Další informace naleznete v tématu Podporované hodnoty typů.
engineeringStation	Logický. Definuje, jestli je zařízení definováno jako technická stanice, nebo ne.	Nelze použít hodnotu null.	- `true`: Zařízení je technická stanice - `false`: Zařízení není technická stanice.
Autorizovaný	Logický. Definuje, jestli je zařízení definováno jako technická stanice, nebo ne.	Nelze použít hodnotu null.	- `true`: Zařízení je technická stanice - `false`: Zařízení není technická stanice
Skeneru	Logický. Definuje, jestli je zařízení autorizované nebo ne.	Nelze použít hodnotu null.	- `true`: Zařízení je autorizované. - `false`: Zařízení není autorizované.
Protokoly	Objekt, který obsahuje podrobnosti protokolu zařízení.	S možnou hodnotou Null	Další informace najdete v tématu Microsoft Defender pro IoT – podporované protokoly IoT, OT, ICS a SCADA.
Firmware	Pole JSON objektu `firmware` , který odporuje firmwaru zařízení.	Nelze použít hodnotu null.	Další informace naleznete v tématu Podporovaná pole firmwaru.
hasDynamicAddress	Logický. Definuje, jestli má zařízení dynamickou adresu, nebo ne.	Nelze použít hodnotu null.	- `true`: Zařízení má dynamickou adresu. - `false`: Zařízení nemá dynamickou adresu.

Podporované `operatingSystem` hodnoty

Tato část obsahuje seznam podporovaných hodnot pro pole odpovědi operačního systému .

Windows 10
Windows 10 32
Windows 10 64
Windows 2000
Windows 7
Windows 7 32
Windows 7 64
Windows 8
Windows 8 32
Windows 8 64
Windows 8.1
Windows 8.1 32

Windows 8.1 64
Windows NT
Windows Server 2003
Windows Server 2003 R2
Windows Server 2008
Windows Server 2008 32
Windows Server 2008 64
Windows Server 2008 R2
Windows Server 2012
Windows Server 2012 R2
Windows Server 2016
Windows Vista

Windows Vista 32
Windows Vista 64
Windows XP
Mac OS
Mac OS X
Linux
Windows Server 2019
HP UX
Windows 11
Windows 11 32
Windows 11 64

Podporované `type` hodnoty

Tato část obsahuje seznam podporovaných hodnot pro pole odpovědi typu .

Engineering Station
PLC
Historian
HMI
Domain Controller
DB Server
Wireless Access Point
Router
Switch
Workstation
Server
IP Camera
Printer
Multicast/Broadcast
Internet
Firewall
Terminal Station
VPN Gateway
Group

IED
DCS Controller
RTU
NTP Server
Storage
Industrial Packaging System
Industrial Scale
Industrial Robot
Slot
Punch Clock
ATM
Smart TV
Game console
DVR
Door Control Panel
HVAC
Thermostat
Fire Alarm
Smart Light

Smart Switch
Fire Detector
IP Telephone
Alarm System
Alarm Siren
Smart Phone
Tablet
Wifi Pineapple
Motion Detector
Elevator
Humidity Sensor
Physical Location
Backup Server
Meter
Barcode Scanner
Uninterruptable Power Supply

Variable Frequency Drive
Robot Controller
Servo Drive
Pneumatic Device
Marquee
People Counter System
Intercom
Turnstile
I/O Adapter
Protocol Converter
KVM
Web Guiding System
Turbine
External Management
Embedded Device
Unknown

Podporovaná pole pro hodnoty objektu `protocols` a protokolu `name`

Tato část obsahuje seznam podporovaných polí pro objekt protokolů v protocols poli odpovědi.

Name	Type	Nullable / Not nullable	Seznam hodnot
id	Číselné. Definuje interní ID protokolu.	Nelze použít hodnotu null.	-
Jméno	Řetězec. Definuje název zařízení.	Nelze použít hodnotu null.	Další informace najdete níže.
ipAddresses	Pole JSON řetězců IP adres protokolu	Nelze použít hodnotu null.	-

Následující hodnoty jsou podporované jako zastaralé názvy protokolů:

Unknown
DNP3
MODBUS
C37.118
SSH
HTTP
SYSLOG
GENERIC
ICMP
DNS
GOOSE
MMS
MALFORMED
IEC-60870
OPC UA
Siemens S7
ARP
Sampled Values
EtherNet/IP

Siemens S7 Plus
Motorola MDLC
Netbios Name Service
Netbios Datagram Service
Lightweight Access Point
CAPWAP
SNMP
DTLS
TNS
Database
SRTP
RPC
OPC
DF-1
DH-485
TDS
SMB
Suitelink
ControlNet

FTP
CDP
Profinet DCP
Profinet Real-Time
LLDP
Telnet
DeltaV
BACNet
AMS
TwinCAT
Ovation ADMD
Ovation SSRPC
Ovation DPUSTAT
Port Map
STP
Telvent OASyS Tags
Mitsubishi MELSEC
Honeywell Control Data Access

ARP
Yokogawa HIS Equalize
Emerson OpenBSI
Siemens SICAM
Omron FINS
Toshiba Computer Link
Foxboro I/A
Yokogawa VNet/IP
Emerson ROC
ABB Totalflow
Siemens Process Historian Discovery
Siemens WinCC Agent
LonTalk
Common ASCII Message
CodeSys
SAIA S-Bus
MDNS
Bently Nevada

Podporovaná pole firmwaru

Tato část obsahuje seznam podporovaných polí pro objekt firmwaru firmware v poli odpovědi.

Name	Type	Nullable / Not nullable	Seznam hodnot
Adresu	Řetězec. Definuje IP adresu firmwaru.	Nelze použít hodnotu null.	-
moduleAddress	Řetězec. Definuje adresu modulu firmwaru.	Nelze použít hodnotu null.	-
Sériové	Řetězec. Definuje sériové číslo firmwaru.	S možnou hodnotou Null	-
Model	Řetězec. Definuje model firmwaru.	S možnou hodnotou Null	-
firmwareVersion	Řetězec. Definuje verzi firmwaru.	S možnou hodnotou Null	-
additionalData	Řetězec. Definuje další data pro firmware.	S možnou hodnotou Null	-
Rack	Řetězec. Definuje rack firmwaru.	S možnou hodnotou Null	-
Slot	Řetězec. Definuje slot firmwaru.	S možnou hodnotou Null	-

Typ: GET

curl -k -H "Authorization: <AUTH_TOKEN>" 'https://<IP_ADDRESS>/api/v1/devices/'

Další kroky

Další informace najdete v přehledu referenčních informací k rozhraní DEFENDER for IoT API.

Sdílet prostřednictvím

Referenční informace k rozhraní API pro správu inventáře pro senzory monitorování OT

připojení (načtení informací o připojení zařízení)

GET

Parametry dotazů

Pole odpovědi na úspěch

Pole protokolu

Příklad odpovědi

připojení na zařízení (načtení konkrétních informací o připojení zařízení)

GET

Parametr cesty

Parametry dotazů

Pole odpovědi na úspěch

Pole protokolu

Příklad odpovědi

cves (Načtení informací o CVEs)

GET

Pole odpovědi na úspěch

Příklad odpovědi

Cves na IP adresu (Načtení konkrétních informací o CVEs)

GET

Parametr cesty

Pole odpovědi na úspěch

Příklad odpovědi

zařízení (načtení informací o zařízení)

GET

Parametr dotazu

Pole odpovědi na úspěch

Podporované `operatingSystem` hodnoty

Podporované `type` hodnoty

Podporovaná pole pro hodnoty objektu `protocols` a protokolu `name`

Podporovaná pole firmwaru

Další kroky

Váš názor

Další materiály