Referenční informace k rozhraní API pro integraci pro místní konzoly pro správu (Public Preview)
Tento článek obsahuje seznam rozhraní API podporovaných pro integraci Microsoft Defender pro IoT s partnerskými službami.
Toto rozhraní API je aktuálně implementované v rámci kurzu Integrace ServiceNow s Microsoft Defender pro IoT prostřednictvím konektoru ServiceNow Service Graph pro Defender for IoT.
Poznámka
Účelem rozhraní API pro integraci je spouštět nepřetržitě a vytvářet neustále běžící datový stream, například dotazovat se na nová data z posledních pěti minut. Rozhraní API pro integraci vrací data s časovým razítkem.
Pokud chcete jednoduše dotazovat data, použijte místo toho běžná neintegrační rozhraní API, buď pro místní konzolu pro správu k dotazování na všechna zařízení, nebo pro konkrétní senzor, který dotazuje zařízení jenom z daného senzoru. Další informace najdete v referenčních informacích k rozhraní API Služby Defender for IoT.
Identifikátor URI: /external/v3/integration/
zařízení (vytvoření a aktualizace zařízení)
Toto rozhraní API vrací data o všech zařízeních, která se aktualizovala po zadaném časovém razítku.
Identifikátor URI: /external/v3/integration/devices/<timestamp>
Parametry identifikátoru URI:
Název | Popis | Příklad | Povinné/volitelné |
---|---|---|---|
Časové razítko | Počáteční čas, od kterého se vrací výsledky, v milisekundách od epochy a v časovém pásmu UTC. | /external/v3/integration/devices/1664781014000 |
Vyžadováno |
GET
- Žádost
- Response (Odpověď)
- Příkaz cURL
Parametry dotazu:
Název | Popis | Příklad | Povinné/volitelné |
---|---|---|---|
sensorId | Vrátí jenom zařízení, která vidí konkrétní senzor. Použijte hodnotu ID z výsledků rozhraní API senzorů (Získat senzory). | 1 |
Volitelné |
typ oznámení | Určuje typy zařízení, která se mají vrátit. Mezi podporované hodnoty patří: - 0 : Aktualizovaná i nová zařízení (výchozí). - 1 : Pouze nová zařízení. - 2 : Pouze aktualizovaná zařízení. |
2 |
Volitelné |
Stránka | Definuje číslo, kde začíná číslování výsledné stránky. Například 0 = první stránka je 0. Výchozí = 0 |
0 |
Volitelné |
Velikost | Definuje velikost stránky. Výchozí = 50 |
75 |
Volitelné |
připojení (získání připojení zařízení)
Toto rozhraní API vrací data o všech připojeních zařízení, která se aktualizovala po zadaném časovém razítku.
Identifikátor URI: /external/v3/integration/connections/<timestamp>
Parametry identifikátoru URI:
Název | Popis | Příklad | Povinné/volitelné |
---|---|---|---|
Časové razítko | Počáteční čas, od kterého se vrací výsledky, v milisekundách od epochy a v časovém pásmu UTC. | /external/v3/integration/devices/1664781014000 |
Vyžadováno |
GET
- Žádost
- Response (Odpověď)
- Příkaz cURL
Parametry dotazu:
Název | Popis | Příklad | Povinné/volitelné |
---|---|---|---|
Stránka | Definuje číslo, kde začíná číslování výsledné stránky. Například 0 = první stránka je 0. Výchozí = 0 |
0 |
Volitelné |
Velikost | Definuje velikost stránky. Výchozí = 50 |
75 |
Volitelné |
zařízení (získání podrobností o zařízení)
Toto rozhraní API vrací data o konkrétním zařízení podle daného ID zařízení.
Identifikátor URI: /external/v3/integration/device/{deviceId}
GET
- Žádost
- Response (Odpověď)
- Příkaz cURL
Parametry dotazu:
Název | Popis | Příklad | Povinné / volitelné |
---|---|---|---|
Deviceid | ID požadovaného zařízení v místní konzole pro správu | 1 |
Vyžadováno |
odstraněná zařízení (získat odstraněná zařízení)
Toto rozhraní API vrátí seznam ID nedávno odstraněných zařízení z zadaného časového razítka.
Identifikátor URI: /external/v3/integration/deleteddevices/
GET
- Žádost
- Response (Odpověď)
- Příkaz cURL
Parametry identifikátoru URI:
Název | Popis | Příklad | Povinné / volitelné |
---|---|---|---|
Časové razítko | Počáteční čas, ze kterého se vrací výsledky, v milisekundách od epochového času a v časovém pásmu UTC. | /external/v3/integration/deleteddevices/1664781014000 |
Vyžadováno |
senzory (získat senzory)
Toto rozhraní API vrátí seznam objektů senzorů pro připojené síťové senzory OT.
Identifikátor URI: /external/v3/integration/sensors/
GET
- Žádost
- Response (Odpověď)
- Příkaz cURL
Identifikátor URI: /sensors
Žádné parametry dotazu
devicecves (získání CVE zařízení)
Toto rozhraní API vrátí seznam aktivních CTE pro všechna zařízení, která se aktualizovala od zadaného časového razítka.
Identifikátor URI: /external/v3/integration/devicecves/
GET
- Žádost
- Response (Odpověď)
- Příkaz cURL
Identifikátor URI: /external/v3/integration/devicecves/<timestamp>
Parametry identifikátoru URI
Název | Popis | Příklad | Povinné/volitelné |
---|---|---|---|
Časové razítko | Počáteční čas, od kterého se vrací výsledky, v milisekundách od epochy a v časovém pásmu UTC. | /external/v3/integration/devicecves/1664781014000 |
Vyžadováno |
Parametry dotazů
Název | Popis | Příklad | Povinné/volitelné |
---|---|---|---|
Stránka | Definuje číslo, kde začíná číslování výsledné stránky. |
0 = první stránka je 0. Výchozí = 0 |
Volitelné |
Velikost | Definuje velikost stránky. | Výchozí = 50 |
Volitelné |
sensorId | Zobrazí výsledky z konkrétního senzoru definované daným ID senzoru. | 1 |
Volitelné |
Skóre | Určuje minimální skóre CVE, které se má načíst. Všechny výsledky budou mít skóre CVE, které se rovná dané hodnotě nebo je větší. | Výchozí = 0 . |
Volitelné |
id zařízení | Seznam id zařízení oddělených čárkami, ze kterých chcete zobrazit výsledky. | Příklad: 1232,34,2,456 |
Volitelné |
Další kroky
Další informace naleznete v tématu: