Skip to content

Commit d67c4c1

Browse files
committed
API v3 title changes
1 parent 6556e01 commit d67c4c1

File tree

1 file changed

+25
-17
lines changed

1 file changed

+25
-17
lines changed

articles/defender-for-iot/organizations/references-work-with-defender-for-iot-apis.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1555,17 +1555,17 @@ This section describes on-premises management console APIs for:
15551555

15561556
### Version 3
15571557

1558-
- [Request devices by timestamp - /external/v3/integration/devices/{timestamp}](#request-devices-by-timestamp---externalv3integrationdevicestimestamp)
1558+
- [Request devices - /external/v3/integration/devices/{timestamp}](#request-devices---externalv3integrationdevicestimestamp)
15591559

1560-
- [Request all device connection events after a given timestamp - /external/v3/integration/connections/{timestamp}](#request-all-device-connection-events-after-a-given-timestamp---externalv3integrationconnectionstimestamp)
1560+
- [Request device connection events - /external/v3/integration/connections/{timestamp}](#request-device-connection-events---externalv3integrationconnectionstimestamp)
15611561

1562-
- [Request specific device data by device ID - /external/v3/integration/device/{deviceId}](#request-specific-device-data-by-device-id---externalv3integrationdevicedeviceid)
1562+
- [Request device data by device ID - /external/v3/integration/device/{deviceId}](#request-device-data-by-device-id---externalv3integrationdevicedeviceid)
15631563

1564-
- [Request deleted devices by a given timestamp - /external/v3/integration/deleteddevices/{timestamp}](#request-deleted-devices-by-a-given-timestamp---externalv3integrationdeleteddevicestimestamp)
1564+
- [Request deleted devices - /external/v3/integration/deleteddevices/{timestamp}](#request-deleted-devices---externalv3integrationdeleteddevicestimestamp)
15651565

15661566
- [Request sensor data - external/v3/integration/sensors](#request-sensor-data---externalv3integrationsensors)
15671567

1568-
- [Request all device CVEs by a given timestamp - /external/v3/integration/devicecves/{timestamp}](#request-all-device-cves-by-a-given-timestamp---externalv3integrationdevicecvestimestamp)
1568+
- [Request all device CVEs - /external/v3/integration/devicecves/{timestamp}](#request-all-device-cves---externalv3integrationdevicecvestimestamp)
15691569

15701570
All parameters in Version 3 APIs are optional.
15711571

@@ -2679,7 +2679,7 @@ Example:
26792679
|-|-|-|
26802680
|GET|`curl -k -H "Authorization: <AUTH_TOKEN>" 'https://<IP_ADDRESS>/external/v2/alerts/pcap/<ID>'`|`curl -k -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" 'https://10.1.0.1/external/v2/alerts/pcap/1'`
26812681

2682-
### Request devices by timestamp - /external/v3/integration/devices/{timestamp}
2682+
### Request devices - /external/v3/integration/devices/{timestamp}
26832683

26842684
This API returns data about all devices that were updated after the given timestamp.
26852685

@@ -2688,6 +2688,7 @@ This API returns data about all devices that were updated after the given timest
26882688
- **GET**
26892689

26902690
#### Path parameters
2691+
26912692
- **timestamp** – the time from which updates are required, only later updates will be returned.
26922693

26932694
#### Query parameters
@@ -2697,8 +2698,8 @@ This API returns data about all devices that were updated after the given timest
26972698
- **0** – both updated and new devices (default).
26982699
- **1** – only new devices.
26992700
- **2** – only updated devices.
2700-
- **page** - the page number, from the result set (first page is 0, default value is 0)ץ
2701-
- **size** - the page size (default value is 50)ץ
2701+
- **page** - the page number, from the result set (first page is 0, default value is 0).
2702+
- **size** - the page size (default value is 50).
27022703

27032704
#### Response type
27042705

@@ -2707,17 +2708,18 @@ This API returns data about all devices that were updated after the given timest
27072708
#### Response structure
27082709

27092710
- **u_count** - amount of objects in the full result sets, including all pages.
2710-
- **u_devices** - array of device objects. Each object is defined with the parameters listed in the [device ID](#request-specific-device-data-by-device-id---externalv3integrationdevicedeviceid) API.
2711+
- **u_devices** - array of device objects. Each object is defined with the parameters listed in the [device ID](#request-device-data-by-device-id---externalv3integrationdevicedeviceid) API.
27112712

2712-
### Request all device connection events after a given timestamp - /external/v3/integration/connections/{timestamp}
2713+
### Request device connection events - /external/v3/integration/connections/{timestamp}
27132714

2714-
This API returns data about all device connections that were updated after the given timestamp.
2715+
This API returns data about all device connection events that were updated after the given timestamp.
27152716

27162717
#### Method
27172718

27182719
- **GET**
27192720

27202721
#### Path parameters
2722+
27212723
- **timestamp** – the time from which updates are required, only later updates will be returned.
27222724

27232725
#### Query parameters
@@ -2740,7 +2742,7 @@ This API returns data about all device connections that were updated after the g
27402742
- **Two Way**
27412743
- **Multicast**
27422744

2743-
### Request specific device data by device ID - /external/v3/integration/device/{deviceId}
2745+
### Request device data by device ID - /external/v3/integration/device/{deviceId}
27442746

27452747
This API returns data about a specific device per a given device ID.
27462748

@@ -2796,7 +2798,9 @@ This API returns data about a specific device per a given device ID.
27962798
- **u_version**
27972799
- **u_additional_data**
27982800

2799-
### Request deleted devices by a given timestamp - /external/v3/integration/deleteddevices/{timestamp}
2801+
### Request deleted devices - /external/v3/integration/deleteddevices/{timestamp}
2802+
2803+
This API returns data about deleted devices after the given timestamp.
28002804

28012805
#### Method
28022806

@@ -2817,6 +2821,8 @@ Array of:
28172821

28182822
### Request sensor data - external/v3/integration/sensors
28192823

2824+
This API returns data about the sensor.
2825+
28202826
#### Method
28212827

28222828
- **GET**
@@ -2864,7 +2870,9 @@ Array of:
28642870
- **u_uid** - globally unique identifier of the sensor.
28652871
- **u_is_in_learning_mode** - boolean indication as to whether the sensor is in Learn mode or not.
28662872

2867-
### Request all device CVEs by a given timestamp - /external/v3/integration/devicecves/{timestamp}
2873+
### Request all device CVEs - /external/v3/integration/devicecves/{timestamp}
2874+
2875+
This API returns data about device CVEs after the given timestamp.
28682876

28692877
#### Method
28702878

@@ -2876,10 +2884,10 @@ Array of:
28762884

28772885
#### Query parameters
28782886

2879-
- **page** - defines the page number, from the result set (first page is 0, default value is 0)
2880-
- **size** - defines the page size (default value is 50)
2887+
- **page** - defines the page number, from the result set (first page is 0, default value is 0).
2888+
- **size** - defines the page size (default value is 50).
28812889
- **sensorId** - shows results from a specific sensor, as defined by the given sensor ID.
2882-
- **score** - determines a minimum CVE score to be retrieved. All results will have a CVE score equal to or higher than the given value. Default = **0**.
2890+
- **score** - determines a minimum CVE score to be retrieved. All results will have a CVE score equal to or higher than the given value. (default value is 0).
28832891
- **deviceIds** - a comma-separated list of device IDs from which you want to show results. For example: **1232,34,2,456**
28842892

28852893
#### Response

0 commit comments

Comments
 (0)