Skip to content

Commit 81bdcc9

Browse files
author
Document Maintainer Bot
committed
20250717-2011.5fddcb9d34
1 parent eb1005f commit 81bdcc9

11 files changed

+40
-36
lines changed

‎saas-restapi-v3/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@
6969
- [Organization admin approval workflow for vulnerability status](<./organization/Organization admin approval workflow for vulnerability status/README.md>)
7070
- [Organization feature](<./organization/Organization feature/README.md>)
7171
- [Organization time to remediate properties](<./organization/Organization time to remediate properties/README.md>)
72-
- [Search](<./organization/Search/README.md>)
7372
- [Organizations](<./organization/Organizations/README.md>)
73+
- [Search](<./organization/Search/README.md>)
7474
- PIVOTAL
7575
- PROFILE
7676
- [Profile](<./profile/Profile/README.md>)
@@ -110,10 +110,10 @@
110110
- [Organization Vulnerabilities Filters](<./trace/Organization Vulnerabilities Filters/README.md>)
111111
- [Organization Vulnerability Bulk Share](<./trace/Organization Vulnerability Bulk Share/README.md>)
112112
- [Organization Vulnerability Stats](<./trace/Organization Vulnerability Stats/README.md>)
113+
- [Security Controls](<./trace/Security Controls/README.md>)
113114
- [Trace Filters](<./trace/Trace Filters/README.md>)
114115
- [Trace Summary](<./trace/Trace Summary/README.md>)
115116
- [Vulnerability Notes](<./trace/Vulnerability Notes/README.md>)
116-
- [Security Controls](<./trace/Security Controls/README.md>)
117117
- USER
118118
- [Report Preferences](<./user/Report Preferences/README.md>)
119119
- [Users](<./user/Users/README.md>)
@@ -134,7 +134,6 @@
134134
- [ApplicationInfoResource](<./objects/ApplicationInfoResource.md>)
135135
- [ApplicationLatestAgentSessionResponse](<./objects/ApplicationLatestAgentSessionResponse.md>)
136136
- [ApplicationNameAndLanguage](<./objects/ApplicationNameAndLanguage.md>)
137-
- [ApplicationResponse](<./objects/ApplicationResponse.md>)
138137
- [ApplicationSessionResponse](<./objects/ApplicationSessionResponse.md>)
139138
- [ApplicationsInfoResponse](<./objects/ApplicationsInfoResponse.md>)
140139
- [ApplicationsNamesAndLanguagesResponse](<./objects/ApplicationsNamesAndLanguagesResponse.md>)
@@ -148,7 +147,6 @@
148147
- [IpDenylistDetailsRequest](<./objects/IpDenylistDetailsRequest.md>)
149148
- [IpDenylistDetailsResponse](<./objects/IpDenylistDetailsResponse.md>)
150149
- [MetadataFieldResource](<./objects/MetadataFieldResource.md>)
151-
- [MetadataFilter](<./objects/MetadataFilter.md>)
152150
- [NgQuickFilterResponse](<./objects/NgQuickFilterResponse.md>)
153151
- [RatingFacet](<./objects/RatingFacet.md>)
154152
- [RatingResult](<./objects/RatingResult.md>)
@@ -161,6 +159,7 @@
161159
- [RouteCoverageServersResponse](<./objects/RouteCoverageServersResponse.md>)
162160
- [RuleConfigurationRequest](<./objects/RuleConfigurationRequest.md>)
163161
- [SarifAsyncExportResponse](<./objects/SarifAsyncExportResponse.md>)
162+
- [SarifRequest](<./objects/SarifRequest.md>)
164163
- [SbavRouteSessionRequest](<./objects/SbavRouteSessionRequest.md>)
165164
- [SbavRouteSessionResponse](<./objects/SbavRouteSessionResponse.md>)
166165
- [SbavSessionResource](<./objects/SbavSessionResource.md>)
@@ -241,6 +240,7 @@
241240
- [ApplicationFilterCatalogResponse](<./objects/ApplicationFilterCatalogResponse.md>)
242241
- [ApplicationGroupsResponse](<./objects/ApplicationGroupsResponse.md>)
243242
- [ApplicationLicenseResponse](<./objects/ApplicationLicenseResponse.md>)
243+
- [ApplicationResponse](<./objects/ApplicationResponse.md>)
244244
- [ApplicationRolesResponse](<./objects/ApplicationRolesResponse.md>)
245245
- [ApplicationServerSettingsEnvironmentResponse](<./objects/ApplicationServerSettingsEnvironmentResponse.md>)
246246
- [ApplicationServerSettingsResponse](<./objects/ApplicationServerSettingsResponse.md>)
@@ -419,6 +419,7 @@
419419
- METADATA RESOURCE
420420
- [MetadataDTO](<./objects/MetadataDTO.md>)
421421
- [MetadataFieldBreakdownDTO](<./objects/MetadataFieldBreakdownDTO.md>)
422+
- [MetadataFilter](<./objects/MetadataFilter.md>)
422423
- [MetadataFilterGroup](<./objects/MetadataFilterGroup.md>)
423424
- [MetadataFilterSubfieldValue](<./objects/MetadataFilterSubfieldValue.md>)
424425
- [MetadataFilterValue](<./objects/MetadataFilterValue.md>)
@@ -621,8 +622,6 @@
621622
- [TimelineEventsResponse](<./objects/TimelineEventsResponse.md>)
622623
- [VirtualPatchResponse](<./objects/VirtualPatchResponse.md>)
623624
- [VirtualPatchesResponse](<./objects/VirtualPatchesResponse.md>)
624-
- REPORTING REQUEST
625-
- [SarifRequest](<./objects/SarifRequest.md>)
626625
- REPORTING RESPONSE
627626
- [ReportAsyncExportResponse](<./objects/ReportAsyncExportResponse.md>)
628627
- ROLE RESOURCE
@@ -704,8 +703,9 @@
704703
- [IPRangeRequest](<./objects/IPRangeRequest.md>)
705704
- [SecurityControlsFilterRequest](<./objects/SecurityControlsFilterRequest.md>)
706705
- [SessionTimeoutRequest](<./objects/SessionTimeoutRequest.md>)
707-
- SECURITY RESPONSE
706+
- SECURITY RESOURCE
708707
- [AuditLogResponseItem](<./objects/AuditLogResponseItem.md>)
708+
- SECURITY RESPONSE
709709
- [IPRangeResponse](<./objects/IPRangeResponse.md>)
710710
- SERVER REQUEST
711711
- [AssessSettings](<./objects/AssessSettings.md>)

‎saas-restapi-v3/objects/ApplicationResponse.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
## ApplicationResponse
22
---
33
### Description
4-
Response that returns the applications information
4+
Application Response
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
8-
| success | Indicates whether API response was successful or not | boolean | | false |
9-
| applications | | list | | false |
8+
| application | Application Resource | ApplicationResource | | false |
109
| messages | List of messages | list | | false |
10+
| success | Indicates whether API response was successful or not | boolean | | false |
1111
### Template
1212
```
13-
{"applications":[],"messages":[],"success":true}
13+
{"application":{"active_attacks":0,"app_id":"","archived":true,"assess":true,"assessPending":true,"attack_label":"","attack_status":"","created":0,"code":0,"code_shorthand":"","defend":true,"defendPending":true,"first_seen":0,"importance":0,"importance_description":"","language":"","last_reset":0,"last_seen":0,"license":{"end":0,"level":"","links":[],"near_expiration":true,"start":0},"links":[],"master":true,"metadataEntities":[],"missingRequiredFields":[],"modules":[],"name":"","notes":"","onboarded_time":0,"override_url":"","parentApplicationId":"","path":"","policies":[],"primary":true,"production_protected":{"links":[],"protect":0,"total":0},"protect":{"isCompletelyUninstrumented":true},"roles":[],"routes":{"discovered":0,"discoveredByUrl":true,"exercised":0,"links":[]},"routingFrameworks":{"frameworks":[],"supported":true},"scores":{"grade":0,"letter_grade":"","library_scoring_type":"","links":[],"overall_scoring_type":"","platform":{"grade":0,"letter_grade":"","links":[]},"security":{"grade":0,"letter_grade":"","links":[]}},"serversWithoutDefend":true,"short_name":"","status":"","tags":[],"techs":[],"total_modules":0,"size":0,"size_shorthand":"","trace_breakdown":{"confirmed":0,"criticals":0,"fixed":0,"highs":0,"links":[],"lows":0,"meds":0,"notProblem":0,"notes":0,"remediated":0,"remediatedAutoVerified":0,"reported":0,"safes":0,"suspicious":0,"traces":0,"triaged":0},"trace_severity_breakdown":[],"validationErrorFields":[]},"messages":[],"success":true}
1414
```

‎saas-restapi-v3/objects/AuditLogResponseItem.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
## AuditLogResponseItem
22
---
33
### Description
4-
Audit Log Response
4+
Audit Log Item
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
8-
| logs | List of logs | list | | false |
9-
| messages | List of messages | list | | false |
10-
| success | Indicates whether API response was successful or not | boolean | | false |
11-
| total | Total number of logs | int | | false |
8+
| date | Date | long | | false |
9+
| message | Message | string | | false |
10+
| timestamp | Timestamp in UTC timezone using ISO-8601 format | localdatetime | | false |
1211
### Template
1312
```
14-
{"logs":[],"messages":[],"success":true,"total":0}
13+
{"date":0,"message":"","timestamp":{}}
1514
```

‎saas-restapi-v3/objects/LibraryRestrictedResource.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ Library Restricted Resource
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
8-
| library_versions_requirements | Libraries versions requirements | list | | false |
8+
| language | Library language | string | | false |
9+
| library_name | Library name | string | | false |
10+
| sha1 | Library SHA1 | string | | false |
911
| versions_behind | Versions behind | integer | | false |
1012
### Template
1113
```
12-
{"library_versions_requirements":[],"links":[],"versions_behind":0}
14+
{"language":"","library_name":"","links":[],"sha1":"","versions_behind":0}
1315
```

‎saas-restapi-v3/objects/MetadataFieldBreakdownDTO.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
## MetadataFieldBreakdownDTO
22
---
33
### Description
4-
Metadata Breakdown Field representation
4+
Metadata Field representation
55
### Template
66
```
7-
{"agentLabel":"","count":0,"displayLabel":"","fieldId":0,"fieldType":"","links":[],"required":true,"subfields":[],"unique":true}
7+
{"agentLabel":"","displayLabel":"","fieldId":0,"fieldType":"","links":[],"required":true,"subfields":[],"unique":true}
88
```

‎saas-restapi-v3/objects/MetadataFilter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Metadata filter
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
8-
| values | Values to filter on | list | | true |
9-
| fieldID | Metadata Field ID | long | | true |
8+
| fieldID | Metadata Field ID | long | | false |
9+
| values | Values to filter on | array | | false |
1010
### Template
1111
```
1212
{"fieldID":0,"values":[]}

‎saas-restapi-v3/objects/NewUserResponse.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
## NewUserResponse
22
---
33
### Description
4-
User Survey Request
4+
User Survey Response
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
8+
| errors | List of errors | list | | false |
9+
| messages | List of messages | list | | false |
810
| state | Survey State | usersurveystate | | false |
11+
| success | Indicates whether API response was successful or not | boolean | | false |
912
### Template
1013
```
11-
{"state":""}
14+
{"errors":[],"messages":[],"state":"","success":true}
1215
```

‎saas-restapi-v3/objects/RaspAttackersResponse.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
## RaspAttackersResponse
22
---
33
### Description
4-
RASP Attackers Response
4+
RASP Event Response
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
8-
| attackers | List of top attackers | list | | false |
98
| errors | List of errors | list | | false |
9+
| items | List of top events | list | | false |
1010
| messages | List of messages | list | | false |
11-
| remaining_attackers | Remaining Attackers | list | | false |
12-
| remaining_breakdown | Remaining attackers breakdown | AttackMonitorTopAttackerResource | | false |
11+
| remaining_breakdown | List of targeted applications | AttackMonitorTopEventResource | | false |
12+
| remaining_events | Remaining Events | list | | false |
1313
| success | Indicates whether API response was successful or not | boolean | | false |
14-
| total | Total number of attack events | long | | false |
14+
| total | Total Events | long | | false |
1515
### Template
1616
```
17-
{"attackers":[],"errors":[],"messages":[],"remaining_attackers":[],"remaining_breakdown":{"attack_status":"","attack_types":[],"attack_uuids":[],"attacker":"","attackersItems":[],"blocked_attacks":0,"exploited_attacks":0,"probed_attacks":0,"source_ips":[],"source_name":"","suspicious_attacks":0,"total_attacks":0,"unknown":true},"success":true,"total":0}
17+
{"errors":[],"items":[],"messages":[],"remaining_breakdown":{"blocked_attacks":0,"event":"","exploited_attacks":0,"probed_attacks":0,"rule_uuid":"","suspicious_attacks":0,"total_attacks":0},"remaining_events":[],"success":true,"total":0}
1818
```

‎saas-restapi-v3/objects/SarifRequest.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
## SarifRequest
22
---
33
### Description
4-
SARIF file generation request
4+
SARIF file generation request
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
88
| metadataFilters | Custom metadata filter groups selected | list | | false |
9+
| toolTypes | Tool types | list | | false |
910
| severities | Vulnerability severities | list | | false |
10-
| toolTypes | Tool types | list | | true |
1111
### Template
1212
```
13-
{"application":{},"metadataFilters":[],"organization":{},"severities":[],"toolTypes":[],"user":{}}
13+
{"metadataFilters":[],"severities":[],"toolTypes":[]}
1414
```

‎saas-restapi-v3/objects/VulnerabilityFilter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ Request object specifying additional filter criteria
3232
| timestampFilter | | vulnerabilitytimestampfield | | false |
3333
| routes | Route coverage hashes | list | | true |
3434
| vulnTypes | | list | | true |
35-
| urls | | list | | true |
3635
| quickFilter | | vulnerabilityquickfiltertype | | false |
36+
| urls | | list | | true |
3737
| untracked | | boolean | | false |
3838
| filterTags | | list | | true |
3939
| applicationID | Filter vulnerabilities by a single application | string | | false |

0 commit comments

Comments
 (0)