Skip to content

Commit 33ec96e

Browse files
committed
Merge branch 'WI370671-api-fixes-for-docs' of https://github.com/DeCohen/defender-docs-pr into WI370671-api-fixes-for-docs
2 parents d7f04b0 + 34508c5 commit 33ec96e

File tree

5 files changed

+15
-15
lines changed

5 files changed

+15
-15
lines changed

CloudAppSecurityDocs/api-activities-feedback.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ POST /api/v1/activities/<pk>/feedback
3232

3333
### Request
3434

35-
Here is an example of the request.
35+
Here's an example of the request.
3636

3737
```rest
3838
curl -XPOST -H "Authorization:Token <your_token_key>" -H "Content-Type: application/json" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/v1/activities/<pk>/feedback" -d '{
@@ -49,7 +49,7 @@ Returns a list of activities in JSON format.
4949

5050
```json
5151
{
52-
"total": 5 // total number of records
52+
"total": 5 // approximate number of records
5353
"hasNext": true // whether there is more data to show or not.
5454
"data": [
5555
// returned records

CloudAppSecurityDocs/api-activities-list.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ POST /api/v1/activities/
2424

2525
| Parameter | Description |
2626
| --- | --- |
27-
| filters | Filter objects with all the search filters for the request, see [activity filters](api-activities.md#filters) for more details |
27+
| filters | Filter objects with all the search filters for the request, for more details see [activity filters](api-activities.md#filters) |
2828
| sortDirection | The sorting direction. Possible values are: `asc` and `desc` |
2929
| sortField | Fields used to sort activities. Possible values are: <li> **date**: The date when then the activity happened <li> **created**: The [timestamp](api-introduction.md#timestamps) when the activity was saved |
3030
| skip | Skips the specified number of records |
@@ -34,7 +34,7 @@ POST /api/v1/activities/
3434

3535
### Request
3636

37-
Here is an example of the request.
37+
Here's an example of the request.
3838

3939
```rest
4040
curl -XPOST -H "Authorization:Token <your_token_key>" -H "Content-Type: application/json" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/v1/activities/" -d '{
@@ -53,7 +53,7 @@ Returns a list of activities in JSON format.
5353

5454
```json
5555
{
56-
"total": 5 // total number of records
56+
"total": 5 // approximate number of records
5757
"hasNext": true // whether there is more data to show or not.
5858
"data": [
5959
// returned records

CloudAppSecurityDocs/api-data-enrichment-list.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ POST /api/v1/subnet/
2424

2525
| Parameter | Description |
2626
| --- | --- |
27-
| filters | Filter objects with all the search filters for the request, see [IP range filters](api-data-enrichment.md#filters) for more details |
27+
| filters | Filter objects with all the search filters for the request, for more details see [IP range filters](api-data-enrichment.md#filters) |
2828
| sortDirection | The sorting direction. Possible values are: `asc` and `desc` |
2929
| sortField | Fields used to sort IP ranges. Possible values are:<br />- **category**: The category of the IP range<br />- **tags**: The tags of the IP range<br />- **name**: The name of the IP range |
3030
| skip | Skips the specified number of records |
@@ -34,7 +34,7 @@ POST /api/v1/subnet/
3434

3535
### Request
3636

37-
Here is an example of the request.
37+
Here's an example of the request.
3838

3939
```rest
4040
curl -XPOST -H "Authorization:Token <your_token_key>" -H "Content-Type: application/json" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/v1/subnet/" -d '{
@@ -53,7 +53,7 @@ Returns a list of IP ranges in JSON format. For information about the response f
5353

5454
```json
5555
{
56-
"total": 1 // total number of records
56+
"total": 1 // approximate number of records
5757
"hasNext": false // whether there is more data to show or not.
5858
"data": [
5959
{

CloudAppSecurityDocs/api-entities-list.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ POST /api/v1/entities/
2727

2828
| Parameter | Description |
2929
| --- | --- |
30-
| filters | Filter objects with all the search filters for the request, see [entity filters](api-entities.md#filters) for more details |
30+
| filters | Filter objects with all the search filters for the request, for more details see [entity filters](api-entities.md#filters) |
3131
| sortDirection | The sorting direction. Possible values are: `asc` and `desc` |
3232
| sortField | Fields used to sort entities. Possible values are:<br />- **date**: The date when then the entity was created<br />- **severity**: The severity of the entity |
3333
| skip | Skips the specified number of records |
@@ -37,7 +37,7 @@ POST /api/v1/entities/
3737

3838
### Request
3939

40-
Here is an example of the request.
40+
Here's an example of the request.
4141

4242
```rest
4343
curl -XPOST -H "Authorization:Token <your_token_key>" -H "Content-Type: application/json" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/v1/entities/" -d '{
@@ -56,7 +56,7 @@ Returns a list of activities in JSON format.
5656

5757
```json
5858
{
59-
"total": 5 // total number of records
59+
"total": 5 // approximate number of records
6060
"hasNext": true // whether there is more data to show or not.
6161
"data": [
6262
// returned records

CloudAppSecurityDocs/api-files-list.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.topic: reference
1111
> [!NOTE]
1212
>
1313
> - This API is not available for Microsoft 365 Cloud App Security.
14-
> - This endpoint may time out when filtering and paginating large collections.
14+
> - This endpoint might time out when filtering and paginating large collections.
1515
1616
Run the GET or POST request to fetch a list of files matching the specified filters.
1717

@@ -29,15 +29,15 @@ POST /api/v1/files/
2929

3030
| Parameter | Description |
3131
| --- | --- |
32-
| filters | Filter objects with all the search filters for the request, see [file filters](api-files.md#filters) for more details |
32+
| filters | Filter objects with all the search filters for the request, for more details see [file filters](api-files.md#filters) |
3333
| skip | Skips the specified number of records |
3434
| limit | Maximum number of records returned by the request |
3535

3636
## Example
3737

3838
### Request
3939

40-
Here is an example of the request.
40+
Here's an example of the request.
4141

4242
```rest
4343
curl -XPOST -H "Authorization:Token <your_token_key>" -H "Content-Type: application/json" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/v1/files/" -d '{
@@ -56,7 +56,7 @@ Returns a list of files in JSON format.
5656

5757
```json
5858
{
59-
"total": 5 // total number of records
59+
"total": 5 // approximate number of records
6060
"hasNext": true // whether there is more data to show or not.
6161
"data": [
6262
// returned records

0 commit comments

Comments
 (0)