Denne artikel indeholder en liste over de API'er til enhedslagerstyring, der understøttes for Defender for IoT OT-sensorer.
Brug denne API til at anmode om en liste over alle enhedsforbindelser.
URI: /api/v1/devices/connections
FÅ
Forespørgselsparametre
Definer en af følgende forespørgselsparametre for at filtrere de returnerede resultater. Hvis du ikke angiver forespørgselsparametre, returneres alle enhedsforbindelser.
| Navn |
Beskrivelse |
Eksempel |
Obligatorisk/valgfri |
|
discoveredBefore |
Numeriske. Filterresultater, der blev fundet før et givet tidspunkt, hvor den angivne tid er defineret i millisekunder fra Epoch-tid og i UTC-tidszone. |
/api/v1/devices/2/connections?discoveredBefore=<epoch> |
Valgfrit |
|
discoveredAfter |
Numeriske. Filterresultater, der blev registreret efter et givet tidspunkt, hvor den angivne tid er defineret i millisekunder fra Epoch-tid og i UTC-tidszone. |
/api/v1/devices/2/connections?discoveredAfter=<epoch> |
Valgfrit |
|
lastActiveInMinutes |
Numeriske. Filtrer resultaterne efter en given tidsramme, hvor forbindelser var aktive. Defineret bagud i minutter fra det aktuelle klokkeslæt. |
/api/v1/devices/2/connections?lastActiveInMinutes=20 |
Valgfrit |
Svartype: JSON
Matrix af JSON-objekter, der repræsenterer enhedsforbindelser, eller følgende fejlmeddelelse:
| Meddelelse |
Beskrivelse |
|
Fejl – fejl |
Handlingen mislykkedes |
Felter for vellykket svar
| Navn |
Type |
Kan være null/Ikke null |
Liste over værdier |
|
firstDeviceId |
Numeriske |
Kan ikke være null |
- |
|
secondDeviceId |
Numeriske |
Kan ikke være null |
- |
|
lastSeen |
Numeriske |
Kan ikke være null |
Epoch (UTC) |
|
Opdaget |
Numeriske |
Kan ikke være null |
Epoch (UTC) |
|
Porte |
Talmatrix |
Kan være null |
- |
|
Protokoller |
JSON-matrix |
Kan være null |
Protokolfelt |
Protokolfelter
| Navn |
Type |
Kan være null/Ikke null |
|
Navn |
String |
Kan ikke være null |
|
Kommandoer |
Strengmatrix |
Kan være null |
Svareksempel
[
{
"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"
]
}
]
}
]
Type: GET
API'er:
curl -k -H "Authorization: <AUTH_TOKEN>" https://<IP_ADDRESS>/api/v1/devices/connections
Eksempler:
curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" https://127.0.0.1/api/v1/devices/connections
Brug denne API til at anmode om en liste over alle forbindelser pr. enhed.
URI: /api/v1/devices/<deviceID>/connections
FÅ
Stiparameter
| Navn |
Beskrivelse |
Eksempel |
Obligatorisk/valgfri |
|
Deviceid |
Hent forbindelser for den angivne enhed. |
/api/v1/devices/<deviceId>/connections |
Påkrævet |
Forespørgselsparametre
| Navn |
Beskrivelse |
Eksempel |
Obligatorisk/valgfri |
|
discoveredBefore |
Numeriske. Filterresultater, der blev fundet før et givet tidspunkt, hvor den angivne tid er defineret i millisekunder fra Epoch-tid og i UTC-tidszone. |
/api/v1/devices/2/connections?discoveredBefore=<epoch> |
Valgfrit |
|
discoveredAfter |
Numeriske. Filterresultater, der blev registreret efter et givet tidspunkt, hvor den angivne tid er defineret i millisekunder fra Epoch-tid og i UTC-tidszone. |
/api/v1/devices/2/connections?discoveredAfter=<epoch> |
Valgfrit |
|
lastActiveInMinutes |
Numeriske. Filtrer resultaterne efter en given tidsramme, hvor forbindelser var aktive. Defineret bagud i minutter fra det aktuelle klokkeslæt. |
/api/v1/devices/2/connections?lastActiveInMinutes=20 |
Valgfrit |
Svartype: JSON
Matrix af JSON-objekter, der repræsenterer enhedsforbindelser, eller følgende fejlmeddelelse:
| Meddelelse |
Beskrivelse |
|
Fejl – fejl |
Handlingen mislykkedes |
Felter for vellykket svar
| Navn |
Type |
Kan være null/Ikke null |
Liste over værdier |
|
firstDeviceId |
Numeriske |
Kan ikke være null |
- |
|
secondDeviceId |
Numeriske |
Kan ikke være null |
- |
|
lastSeen |
Numeriske |
Kan ikke være null |
Epoch (UTC) |
|
Opdaget |
Numeriske |
Kan ikke være null |
Epoch (UTC) |
|
Porte |
Talmatrix |
Kan være null |
- |
|
Protokoller |
JSON-matrix |
Kan være null |
Protokolfelt |
Protokolfelter
| Navn |
Type |
Kan være null/Ikke null |
|
Navn |
String |
Kan ikke være null |
|
Kommandoer |
Strengmatrix |
Kan være null |
Svareksempel
[
{
"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"
]
}
]
}
]
Type: GET
API'er:
curl -k -H "Authorization: <AUTH_TOKEN>" 'https://<IP_ADDRESS>/api/v1/devices/<deviceId>/connections?lastActiveInMinutes=&discoveredBefore=&discoveredAfter=
Eksempler:
Med de angivne forespørgselsparametre:
curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" 'https://127.0.0.1/api/v1/devices/2/connections?lastActiveInMinutes=20&discoveredBefore=1594550986000&discoveredAfter=1594550986000
Brug denne API til at anmode om en liste over alle kendte CVEs, der er registreret på enheder i netværket, sorteret efter faldende CVE-score.
URI: /api/v1/devices/cves
FÅ
Eksempel: /api/v1/devices/cves
Definer en af følgende forespørgselsparametre for at filtrere de returnerede resultater.
| Navn |
Beskrivelse |
Eksempel |
Obligatorisk/valgfri |
|
Top |
Numeriske. Bestem, hvor mange TOP-scorede CVEs der skal hentes for hver enheds IP-adresse. |
/api/v1/devices/cves?top=50
/api/v1/devices/<ipAddress>/cves?top=50 |
Valgfri. Standard = 100 |
Type: JSON
JSON-matrix af enheds-CVE-objekter eller følgende fejlmeddelelse:
| Meddelelse |
Beskrivelse |
|
Fejl – fejl |
Handlingen mislykkedes |
Felter for vellykket svar
| Navn |
Type |
Kan være null/Ikke null |
Liste over værdier |
|
cveId |
String |
Kan ikke være null |
Et vedtaget branchestandard-id for det angivne CVE. |
|
Ipadresse |
String |
Kan ikke være null |
IP-adresser |
|
Score |
String |
Kan ikke være null |
En CVE-score mellem 0,0-10,0 |
|
attackVector |
String |
Kan ikke være null |
Network, Adjacent Network, Localeller Physical |
|
Beskrivelse |
String |
Kan ikke være null |
- |
Svareksempel
[
{
"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.\""
}
]
Type: GET
API'er:
curl -k -H "Authorization: <AUTH_TOKEN>" https://<IP_ADDRESS>/api/v1/devices/cves
Eksempler:
curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" https://127.0.0.1/api/v1/devices/cves
Brug denne API til at anmode om en liste over alle kendte CVEs, der er registreret på enheder i netværket, for en bestemt IP-adresse.
URI: /api/v1/devices/cves
FÅ
Eksempel: /api/v1/devices/cves
Stiparameter
| Navn |
Beskrivelse |
Eksempel |
Obligatorisk/valgfri |
|
Ipadresse |
Hent CVEs for den angivne IP-adresse. |
/api/v1/devices/<ipAddress>/cves |
Påkrævet |
Definer følgende forespørgselsparameter for at filtrere de returnerede resultater.
| Navn |
Beskrivelse |
Eksempel |
Obligatorisk/valgfri |
|
Top |
Numeriske. Bestem, hvor mange TOP-scorede CVEs der skal hentes for hver enheds IP-adresse. |
/api/v1/devices/cves?top=50
/api/v1/devices/<ipAddress>/cves?top=50 |
Valgfri. Standard = 100 |
Type: JSON
JSON-matrix af enheds-CVE-objekter eller følgende fejlmeddelelse:
| Meddelelse |
Beskrivelse |
|
Fejl – fejl |
Handlingen mislykkedes |
Felter for vellykket svar
| Navn |
Type |
Kan være null/Ikke null |
Liste over værdier |
|
cveId |
String |
Kan ikke være null |
Et vedtaget branchestandard-id for det angivne CVE. |
|
Ipadresse |
String |
Kan ikke være null |
IP-adresser |
|
Score |
String |
Kan ikke være null |
En CVE-score mellem 0,0-10,0 |
|
attackVector |
String |
Kan ikke være null |
Network, Adjacent Network, Localeller Physical |
|
Beskrivelse |
String |
Kan ikke være null |
- |
Svareksempel
[
{
"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.\""
}
]
Type: GET
API'er:
curl -k -H "Authorization: <AUTH_TOKEN>" https://<IP_ADDRESS>/api/v1/devices/<deviceIpAddress>/cves?top=
Eksempler:
Med de angivne forespørgselsparametre:
curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" https://127.0.0.1/api/v1/devices/10.10.10.15/cves?top=50
Brug denne API til at anmode om en liste over alle enheder, der er registreret af denne sensor.
URI: api/v1/devices/
FÅ
Forespørgselsparameter
Definer følgende forespørgselsparameter for at filtrere de returnerede resultater. Hvis du ikke angiver forespørgselsparametre, returneres alle enhedsforbindelser.
| Navn |
Beskrivelse |
Eksempel |
Obligatorisk/valgfri |
|
Autoriseret |
Boolesk:
-
true: Filtrer kun efter data på godkendte enheder.
-
false: Filtrer kun efter data på uautoriserede enheder. |
/api/v1/devices/ |
Valgfrit |
Svartype: JSON
Matrix af JSON-objekter, der repræsenterer enhedsobjekter, eller følgende fejlmeddelelse:
| Meddelelse |
Beskrivelse |
|
Fejl – fejl |
Handlingen mislykkedes |
Felter for vellykket svar
| Navn |
Type |
Kan være null/Ikke null |
Liste over værdier |
|
id |
Numeriske. Definerer enheds-id'et. |
Kan ikke være null |
- |
|
ipAddresses |
JSON-matrix af strenge. |
Kan være null |
- |
|
Navn |
Streng. Definerer enhedsnavnet. |
Kan ikke være null |
- |
|
Kreditor |
Streng. Definerer enhedens leverandør. |
Kan være null |
- |
|
operatingSystem |
Enum. Definerer enhedens operativsystem. |
Kan være null |
Du kan få flere oplysninger under Understøttede operatingSystem-værdier. |
|
macAddresses |
JSON-matrix af strenge. |
Kan være null |
- |
|
Type |
Streng. Definerer enhedstypen. |
Kan ikke være null |
Kan være Unknown. Du kan få flere oplysninger under Understøttede typeværdier. |
|
engineeringStation |
Boolesk. Definerer, om enheden er defineret som en teknisk station eller ej. |
Kan ikke være null |
-
true: Enheden er en teknisk station
-
false: Enheden er ikke en teknisk station. |
|
Autoriseret |
Boolesk. Definerer, om enheden er defineret som en teknisk station eller ej. |
Kan ikke være null |
-
true: Enheden er en teknisk station
-
false: Enheden er ikke en teknisk station |
|
Scanner |
Boolesk. Definerer, om enheden er godkendt eller ej. |
Kan ikke være null |
-
true: Enheden er godkendt
-
false: Enheden er ikke godkendt |
|
Protokoller |
Objekt, der indeholder oplysninger om enhedens protokol. |
Kan være null |
Du kan få flere oplysninger under Microsoft Defender til IoT - understøttede protokoller af typen IoT, OT, ICS og SCADA. |
|
Firmware |
JSON-matrix for et firmware objekt, der trodser enhedens firmware. |
Kan ikke være null |
Du kan få flere oplysninger under Understøttede firmwarefelter. |
|
hasDynamicAddress |
Boolesk. Definerer, om enheden har en dynamisk adresse eller ej. |
Kan ikke være null |
-
true: Enheden har en dynamisk adresse
-
false: Enheden har ikke en dynamisk adresse |
Understøttede operatingSystem værdier
I dette afsnit vises de understøttede værdier for operatingSystem-svarfeltet .
Windows 10Windows 10 32Windows 10 64Windows 2000Windows 7Windows 7 32Windows 7 64Windows 8Windows 8 32Windows 8 64Windows 8.1Windows 8.1 32
Windows 8.1 64Windows NTWindows Server 2003Windows Server 2003 R2Windows Server 2008Windows Server 2008 32Windows Server 2008 64Windows Server 2008 R2Windows Server 2012Windows Server 2012 R2Windows Server 2016Windows Vista
Windows Vista 32Windows Vista 64Windows XPMac OSMac OS XLinuxWindows Server 2019HP UXWindows 11Windows 11 32Windows 11 64
Understøttede type værdier
I dette afsnit vises de understøttede værdier for svarfeltet af typen .
Engineering StationPLCHistorianHMIDomain ControllerDB ServerWireless Access PointRouterSwitchWorkstationServerIP CameraPrinterMulticast/BroadcastInternetFirewallTerminal StationVPN GatewayGroup
IEDDCS ControllerRTUNTP ServerStorageIndustrial Packaging SystemIndustrial ScaleIndustrial RobotSlotPunch ClockATMSmart TVGame consoleDVRDoor Control PanelHVACThermostatFire AlarmSmart Light
Smart SwitchFire DetectorIP TelephoneAlarm SystemAlarm SirenSmart PhoneTabletWifi PineappleMotion DetectorElevatorHumidity SensorPhysical LocationBackup ServerMeterBarcode ScannerUninterruptible Power Supply
Variable Frequency DriveRobot ControllerServo DrivePneumatic DeviceMarqueePeople Counter SystemIntercomTurnstileI/O AdapterProtocol ConverterKVMWeb Guiding SystemTurbineExternal ManagementEmbedded DeviceUnknown
Understøttede felter for objektet og protokolværdierne protocolsname
I dette afsnit vises de understøttede felter for protokollerobjektetprotocols i svarfeltet.
| Navn |
Type |
Kan være null/Ikke null |
Liste over værdier |
|
id |
Numeriske. Definerer protokollens interne id. |
Kan ikke være null |
- |
|
Navn |
Streng. Definerer enhedsnavnet. |
Kan ikke være null |
Du kan få flere oplysninger nedenfor. |
|
ipAddresses |
JSON-matrix af strenge af protokol-IP-adresser. |
Kan ikke være null |
- |
Følgende værdier understøttes som protokolnavne , der er indbyggede:
UnknownDNP3MODBUSC37.118SSHHTTPSYSLOGGENERICICMPDNSGOOSEMMSMALFORMEDIEC-60870OPC UASiemens S7ARPSampled ValuesEtherNet/IP
Siemens S7 PlusMotorola MDLCNetbios Name ServiceNetbios Datagram ServiceLightweight Access PointCAPWAPSNMPDTLSTNSDatabaseSRTPRPCOPCDF-1DH-485TDSSMBSuitelinkControlNet
FTPCDPProfinet DCPProfinet Real-TimeLLDPTelnetDeltaVBACNetAMSTwinCATOvation ADMDOvation SSRPCOvation DPUSTATPort MapSTPTelvent OASyS TagsMitsubishi MELSECHoneywell Control Data Access
ARPYokogawa HIS EqualizeEmerson OpenBSISiemens SICAMOmron FINSToshiba Computer LinkFoxboro I/AYokogawa VNet/IPEmerson ROCABB TotalflowSiemens Process Historian DiscoverySiemens WinCC AgentLonTalkCommon ASCII MessageCodeSysSAIA S-BusMDNSBently Nevada
Understøttede firmwarefelter
I dette afsnit vises de understøttede felter for firmwareobjektet i firmware svarfeltet.
| Navn |
Type |
Kan være null/Ikke null |
Liste over værdier |
|
Adresse |
Streng. Definerer firmwarens IP-adresse. |
Kan ikke være null |
- |
|
moduleAddress |
Streng. Definerer firmwarens moduladresse. |
Kan ikke være null. |
- |
|
Serie |
Streng. Definerer firmwarens serienummer. |
Kan være null |
- |
|
Model |
Streng. Definerer firmwaremodellen. |
Kan være null |
- |
|
firmwareVersion |
Streng. Definerer firmwareversionen. |
Kan være null |
- |
|
additionalData |
Streng. Definerer yderligere data for firmwaren. |
Kan være null |
- |
|
Rack |
Streng. Definerer firmwarereolen. |
Kan være null |
- |
|
Slot |
Streng. Definerer firmwarens slot. |
Kan være null |
- |
Type: GET
curl -k -H "Authorization: <AUTH_TOKEN>" 'https://<IP_ADDRESS>/api/v1/devices/'
Næste trin
Du kan få flere oplysninger i referenceoversigten for Defender for IoT API.