다음을 통해 공유


온-프레미스 관리 콘솔에 대한 통합 API 참조(공개 미리 보기)

이 문서에서는 Microsoft Defender for IoT를 파트너 서비스와 통합하는 데 지원되는 API를 나열합니다.

예를 들어 이 API는 현재 자습서를 통해 구현됩니다. ServiceNow와 IoT용 Microsoft Defender 통합ServiceNow Service Graph Connector for Defender를 통해 IoT용 ServiceNow를 통합합니다.

메모

통합 API는 지속적으로 실행되고, 지난 5분 동안의 새 데이터를 쿼리하는 것과 같이 지속적으로 실행되는 데이터 스트림을 만들기 위한 것입니다. 통합 API는 타임스탬프를 사용하여 데이터를 반환합니다.

단순히 데이터를 쿼리하려면 온-프레미스 관리 콘솔에서 모든 디바이스를 쿼리하거나 특정 센서가 해당 센서에서만 디바이스를 쿼리하는 일반 비통합 API를 대신 사용합니다. 자세한 내용은 Defender for IoT API 참조참조하세요.

URI: /external/v3/integration/

디바이스(디바이스 만들기 및 업데이트)

이 API는 지정된 타임스탬프 후에 업데이트된 모든 디바이스에 대한 데이터를 반환합니다.

URI: /external/v3/integration/devices/<timestamp>

URI 매개 변수:

이름 묘사 본보기 필수/선택 사항
타임스탬프 결과가 반환되는 시작 시간(Epoch 시간 및 UTC 표준 시간대에서 밀리초)입니다. /external/v3/integration/devices/1664781014000 필수

가져오기

쿼리 매개 변수:

이름 묘사 본보기 필수/선택 사항
sensorId 특정 센서에서 볼 수 있는 디바이스만 반환합니다. 센서(센서 가져오기) API의 결과에서 ID 값을 사용합니다. 1 선택적
notificationType 반환할 디바이스 유형을 결정합니다. 지원되는 값은 다음과 같습니다.
- 0: 업데이트된 디바이스와 새 디바이스 모두(기본값)
- 1: 새 디바이스만.
- 2: 업데이트된 디바이스만.
2 선택적
페이지 결과 페이지 번호 매기기 시작 번호를 정의합니다. 예를 들어 0= 첫 번째 페이지는 0.
기본값 = 0
0 선택적
크기 페이지 크기 조정을 정의합니다. 기본값 = 50 75 선택적

연결(디바이스 연결 가져오기)

이 API는 지정된 타임스탬프 후에 업데이트된 모든 디바이스 연결에 대한 데이터를 반환합니다.

URI: /external/v3/integration/connections/<timestamp>

URI 매개 변수:

이름 묘사 본보기 필수/선택 사항
타임스탬프 결과가 반환되는 시작 시간(Epoch 시간 및 UTC 표준 시간대에서 밀리초)입니다. /external/v3/integration/devices/1664781014000 필수

가져오기

쿼리 매개 변수:

이름 묘사 본보기 필수/선택 사항
페이지 결과 페이지 번호 매기기 시작 번호를 정의합니다. 예를 들어 0= 첫 번째 페이지는 0.
기본값 = 0
0 선택적
크기 페이지 크기 조정을 정의합니다. 기본값 = 50 75 선택적

디바이스(디바이스에 대한 세부 정보 가져오기)

이 API는 지정된 디바이스 ID당 특정 디바이스에 대한 데이터를 반환합니다.

URI: /external/v3/integration/device/{deviceId}

가져오기

쿼리 매개 변수:

이름 묘사 본보기 필수/선택 사항
deviceId 온-프레미스 관리 콘솔에서 요청된 디바이스의 ID 1 필수

deleteddevices(삭제된 디바이스 가져오기)

이 API는 제공된 타임스탬프에서 최근에 삭제된 디바이스의 ID 목록을 반환합니다.

URI: /external/v3/integration/deleteddevices/

가져오기

URI 매개 변수:

이름 묘사 본보기 필수/선택 사항
타임스탬프 결과가 반환되는 시작 시간(Epoch 시간 및 UTC 표준 시간대에서 밀리초)입니다. /external/v3/integration/deleteddevices/1664781014000 필수

센서(센서 가져오기)

이 API는 연결된 OT 네트워크 센서에 대한 센서 개체 목록을 반환합니다.

URI: /external/v3/integration/sensors/

가져오기

URI: /sensors

쿼리 매개 변수 없음

devicecves(디바이스 CVE 가져오기)

이 API는 제공된 타임스탬프 이후 업데이트된 모든 디바이스에 대한 활성 CVE 목록을 반환합니다.

URI: /external/v3/integration/devicecves/

가져오기

URI: /external/v3/integration/devicecves/<timestamp>

URI 매개 변수

이름 묘사 본보기 필수/선택 사항
타임스탬프 결과가 반환되는 시작 시간(Epoch 시간 및 UTC 표준 시간대에서 밀리초)입니다. /external/v3/integration/devicecves/1664781014000 필수

쿼리 매개 변수

이름 묘사 본보기 필수/선택 사항
페이지 결과 페이지 번호 매기기 시작 번호를 정의합니다. 0= 첫 번째 페이지는 0.
기본값 = 0
선택적
크기 페이지 크기 조정을 정의합니다. 기본값 = 50 선택적
sensorId 지정된 센서 ID로 정의된 특정 센서의 결과를 표시합니다. 1 선택적
점수 검색할 최소 CVE 점수를 결정합니다. 모든 결과에는 지정된 값보다 크거나 같은 CVE 점수가 있습니다. 기본값 = 0. 선택적
deviceIds 결과를 표시하려는 디바이스 ID의 쉼표로 구분된 목록입니다. 예: 1232,34,2,456 선택적

다음 단계

자세한 내용은 다음을 참조하세요.