Skip to content

Commit a74a869

Browse files
author
Document Maintainer Bot
committed
20250702-2052.9ff4a96702
1 parent f9f864d commit a74a869

16 files changed

+114
-111
lines changed

saas-restapi-v3/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@
7676
- [Profile](<./profile/Profile/README.md>)
7777
- RASP
7878
- [History Attacks](<./rasp/History Attacks/README.md>)
79-
- [Rasp Event Filters](<./rasp/Rasp Event Filters/README.md>)
8079
- [Licenses](<./rasp/Licenses/README.md>)
80+
- [Rasp Event Filters](<./rasp/Rasp Event Filters/README.md>)
8181
- [Users](<./rasp/Users/README.md>)
8282
- REPORTING
8383
- [Sarif](<./reporting/Sarif/README.md>)
@@ -134,11 +134,12 @@
134134
- [ApplicationInfoResource](<./objects/ApplicationInfoResource.md>)
135135
- [ApplicationLatestAgentSessionResponse](<./objects/ApplicationLatestAgentSessionResponse.md>)
136136
- [ApplicationNameAndLanguage](<./objects/ApplicationNameAndLanguage.md>)
137-
- [ApplicationResponse](<./objects/ApplicationResponse.md>)
137+
- [ApplicationResource](<./objects/ApplicationResource.md>)
138138
- [ApplicationSessionResponse](<./objects/ApplicationSessionResponse.md>)
139139
- [ApplicationsInfoResponse](<./objects/ApplicationsInfoResponse.md>)
140140
- [ApplicationsNamesAndLanguagesResponse](<./objects/ApplicationsNamesAndLanguagesResponse.md>)
141141
- [BaseApiFormResponse](<./objects/BaseApiFormResponse.md>)
142+
- [BaseApiResponse](<./objects/BaseApiResponse.md>)
142143
- [Facet](<./objects/Facet.md>)
143144
- [FacetValue](<./objects/FacetValue.md>)
144145
- [FacetsResult](<./objects/FacetsResult.md>)
@@ -148,6 +149,7 @@
148149
- [IpDenylistDetailsRequest](<./objects/IpDenylistDetailsRequest.md>)
149150
- [IpDenylistDetailsResponse](<./objects/IpDenylistDetailsResponse.md>)
150151
- [MetadataFieldResource](<./objects/MetadataFieldResource.md>)
152+
- [MetadataFilter](<./objects/MetadataFilter.md>)
151153
- [NgQuickFilterResponse](<./objects/NgQuickFilterResponse.md>)
152154
- [RatingFacet](<./objects/RatingFacet.md>)
153155
- [RatingResult](<./objects/RatingResult.md>)
@@ -156,10 +158,10 @@
156158
- [RouteCoverageAsyncExportResponse](<./objects/RouteCoverageAsyncExportResponse.md>)
157159
- [RouteCoverageBaseApiResponse](<./objects/RouteCoverageBaseApiResponse.md>)
158160
- [RouteCoverageFilterItem](<./objects/RouteCoverageFilterItem.md>)
159-
- [RouteCoverageFilterRequest](<./objects/RouteCoverageFilterRequest.md>)
160161
- [RouteCoverageServersResponse](<./objects/RouteCoverageServersResponse.md>)
161162
- [RuleConfigurationRequest](<./objects/RuleConfigurationRequest.md>)
162163
- [SarifAsyncExportResponse](<./objects/SarifAsyncExportResponse.md>)
164+
- [SarifRequest](<./objects/SarifRequest.md>)
163165
- [SbavRouteSessionRequest](<./objects/SbavRouteSessionRequest.md>)
164166
- [SbavRouteSessionResponse](<./objects/SbavRouteSessionResponse.md>)
165167
- [SbavSessionResource](<./objects/SbavSessionResource.md>)
@@ -186,6 +188,7 @@
186188
- [AgentVersionsResponse](<./objects/AgentVersionsResponse.md>)
187189
- APPLICATION COVERAGE REQUEST
188190
- [RouteCoverageBySessionIDAndMetadataRequest](<./objects/RouteCoverageBySessionIDAndMetadataRequest.md>)
191+
- [RouteCoverageFilterRequest](<./objects/RouteCoverageFilterRequest.md>)
189192
- [RouteCoverageMetadataLabelValues](<./objects/RouteCoverageMetadataLabelValues.md>)
190193
- APPLICATION COVERAGE RESOURCE
191194
- [RouteCoverageMetricsResource](<./objects/RouteCoverageMetricsResource.md>)
@@ -218,7 +221,6 @@
218221
- [ApplicationModuleResource](<./objects/ApplicationModuleResource.md>)
219222
- [ApplicationNameResource](<./objects/ApplicationNameResource.md>)
220223
- [ApplicationProtectResource](<./objects/ApplicationProtectResource.md>)
221-
- [ApplicationResource](<./objects/ApplicationResource.md>)
222224
- [ApplicationRoutingFrameworkResource](<./objects/ApplicationRoutingFrameworkResource.md>)
223225
- [ApplicationServerProtectionResource](<./objects/ApplicationServerProtectionResource.md>)
224226
- [ApplicationServerResource](<./objects/ApplicationServerResource.md>)
@@ -240,6 +242,7 @@
240242
- [ApplicationFilterCatalogResponse](<./objects/ApplicationFilterCatalogResponse.md>)
241243
- [ApplicationGroupsResponse](<./objects/ApplicationGroupsResponse.md>)
242244
- [ApplicationLicenseResponse](<./objects/ApplicationLicenseResponse.md>)
245+
- [ApplicationResponse](<./objects/ApplicationResponse.md>)
243246
- [ApplicationRolesResponse](<./objects/ApplicationRolesResponse.md>)
244247
- [ApplicationServerSettingsEnvironmentResponse](<./objects/ApplicationServerSettingsEnvironmentResponse.md>)
245248
- [ApplicationServerSettingsResponse](<./objects/ApplicationServerSettingsResponse.md>)
@@ -361,7 +364,6 @@
361364
- [AuthSettingsResponse](<./objects/AuthSettingsResponse.md>)
362365
- [BackgroundJobResponse](<./objects/BackgroundJobResponse.md>)
363366
- [BaseApiCountResponse](<./objects/BaseApiCountResponse.md>)
364-
- [BaseApiResponse](<./objects/BaseApiResponse.md>)
365367
- [BulkBackgroundJobResponse](<./objects/BulkBackgroundJobResponse.md>)
366368
- [CategoryRulesResponse](<./objects/CategoryRulesResponse.md>)
367369
- [DateFormatsResponse](<./objects/DateFormatsResponse.md>)
@@ -416,7 +418,6 @@
416418
- METADATA RESOURCE
417419
- [MetadataDTO](<./objects/MetadataDTO.md>)
418420
- [MetadataFieldBreakdownDTO](<./objects/MetadataFieldBreakdownDTO.md>)
419-
- [MetadataFilter](<./objects/MetadataFilter.md>)
420421
- [MetadataFilterGroup](<./objects/MetadataFilterGroup.md>)
421422
- [MetadataFilterSubfieldValue](<./objects/MetadataFilterSubfieldValue.md>)
422423
- [MetadataFilterValue](<./objects/MetadataFilterValue.md>)
@@ -445,7 +446,6 @@
445446
- [NotificationUserTriggerRequest](<./objects/NotificationUserTriggerRequest.md>)
446447
- NOTIFICATION RESOURCE
447448
- [AlertConditionResource](<./objects/AlertConditionResource.md>)
448-
- [AlertResource](<./objects/AlertResource.md>)
449449
- [NotificationOrganizationSettingsResource](<./objects/NotificationOrganizationSettingsResource.md>)
450450
- [NotificationOrganizationTriggerChannelResource](<./objects/NotificationOrganizationTriggerChannelResource.md>)
451451
- [NotificationOrganizationTriggerResource](<./objects/NotificationOrganizationTriggerResource.md>)
@@ -543,6 +543,7 @@
543543
- [AlertAttackTriggerIntervalResource](<./objects/AlertAttackTriggerIntervalResource.md>)
544544
- [AlertAttackTriggerResource](<./objects/AlertAttackTriggerResource.md>)
545545
- [AlertAttackTriggerStatusResource](<./objects/AlertAttackTriggerStatusResource.md>)
546+
- [AlertResource](<./objects/AlertResource.md>)
546547
- [ApplicationAttackResource](<./objects/ApplicationAttackResource.md>)
547548
- [AssessmentLicenseBreakdownResource](<./objects/AssessmentLicenseBreakdownResource.md>)
548549
- [AttackApplicationResource](<./objects/AttackApplicationResource.md>)
@@ -619,8 +620,6 @@
619620
- [TimelineEventsResponse](<./objects/TimelineEventsResponse.md>)
620621
- [VirtualPatchResponse](<./objects/VirtualPatchResponse.md>)
621622
- [VirtualPatchesResponse](<./objects/VirtualPatchesResponse.md>)
622-
- REPORTING REQUEST
623-
- [SarifRequest](<./objects/SarifRequest.md>)
624623
- REPORTING RESPONSE
625624
- [ReportAsyncExportResponse](<./objects/ReportAsyncExportResponse.md>)
626625
- ROLE RESOURCE
@@ -702,8 +701,9 @@
702701
- [IPRangeRequest](<./objects/IPRangeRequest.md>)
703702
- [SecurityControlsFilterRequest](<./objects/SecurityControlsFilterRequest.md>)
704703
- [SessionTimeoutRequest](<./objects/SessionTimeoutRequest.md>)
705-
- SECURITY RESPONSE
704+
- SECURITY RESOURCE
706705
- [AuditLogResponseItem](<./objects/AuditLogResponseItem.md>)
706+
- SECURITY RESPONSE
707707
- [IPRangeResponse](<./objects/IPRangeResponse.md>)
708708
- SERVER REQUEST
709709
- [AssessSettings](<./objects/AssessSettings.md>)

saas-restapi-v3/objects/AccessGroupResource.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,16 @@ EAC Group Resource
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
8-
| users | List of Users | list | | false |
8+
| access_level | Access level | accesscontrolgrouplevel | | false |
9+
| accounts | List of account roles | list | | false |
10+
| applications | List of all application that have access in this group | list | | false |
11+
| group_id | Group ID | long | | false |
12+
| is_onboarded_to_group | Whether Application access is onboarded to group | boolean | | false |
13+
| name | Group Name | string | | false |
14+
| readonly | Is group read-only | boolean | | false |
15+
| role | Role for all the applications | string | | false |
16+
| total_users | Number of users in this group | long | | false |
917
### Template
1018
```
11-
{"links":[],"users":[]}
19+
{"access_level":"","accounts":[],"applications":[],"group_id":0,"is_onboarded_to_group":true,"links":[],"name":"","readonly":true,"role":"","total_users":0}
1220
```

saas-restapi-v3/objects/AlertResource.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,22 @@ Alert Resource
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
8-
| alert_id | Alert id | string | | false |
8+
| alert_id | Alert ID | string | | false |
9+
| allAppsEnabled | Enable all applications | boolean | | false |
910
| allUsers | Enable for all users | boolean | | false |
10-
| apps | List of Application Alert Resources | list | | false |
11+
| apps | List of applications | list | | false |
1112
| conditions | List of conditions | list | | false |
1213
| description | Description | string | | false |
1314
| enabled | Enabled | boolean | | false |
1415
| frequency | Frequency | string | | false |
1516
| last_send_time | Last send time | long | | false |
16-
| name | Notification Name | string | | false |
17+
| name | Alert Name | string | | false |
1718
| recipients | List of recipients | list | | false |
1819
| tags | List of application tags | collection | | false |
20+
| triggers | List of triggers | list | | false |
1921
| type | Alert type | alerttype | | false |
2022
| users | List of TeamServer users recipients | list | | false |
2123
### Template
2224
```
23-
{"frequency":"","alert_id":"","allUsers":true,"apps":[],"conditions":[],"description":"","enabled":true,"last_send_time":0,"links":[],"name":"","recipients":[],"tags":[],"type":"","users":[]}
25+
{"frequency":"","alert_id":"","allAppsEnabled":true,"allUsers":true,"apps":[],"conditions":[],"description":"","enabled":true,"last_send_time":0,"links":[],"name":"","recipients":[],"tags":[],"triggers":[],"type":"","users":[]}
2426
```
Lines changed: 9 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,18 @@
11
## ApplicationResource
22
---
33
### Description
4-
Application Resource
4+
Resource that contains the information about the application object
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
8-
| active_attacks | Total number of active attacks | long | | false |
9-
| app_id | Application ID | string | | false |
10-
| archived | Is application archived | boolean | | false |
11-
| assess | Is assessment enabled | boolean | | false |
12-
| assessPending | Is assessment pending for at least one of this application&#x27;s server | boolean | | false |
13-
| attack_label | Attack status label | string | | false |
14-
| attack_status | Attack status | attackstatus | | false |
15-
| code | Custom classes LoC | long | | false |
16-
| code_shorthand | Custom classes LoC shorthand | string | | false |
17-
| created | Time created | long | | false |
18-
| defend | Is defense enabled | boolean | | false |
19-
| defendPending | Is defense pending for any of this application&#x27;s servers | boolean | | false |
20-
| first_seen | Application first time seen | long | | false |
21-
| importance | Application Importance | integer | | false |
22-
| importance_description | Application Importance Description | applicationimportance | | false |
23-
| language | Application language | string | | false |
24-
| last_reset | Time last reset | long | | false |
25-
| last_seen | Time last seen | long | | false |
26-
| license | Application licenses | ApplicationLicenseResource | | false |
27-
| master | Is application master | boolean | | false |
28-
| metadataEntities | List of metadata entities | list | | false |
29-
| missingRequiredFields | List of missing required metadata fields | list | | false |
30-
| modules | Application child modules | list | | false |
31-
| name | Application name | string | | false |
32-
| notes | Application notes | string | | false |
33-
| onboarded_time | Time when the application was onboarded (this doesn&#x27;t include parent or modules) | long | | false |
34-
| override_url | Override url | string | | false |
35-
| parentApplicationId | Parent Application ID | string | | false |
36-
| path | Application path | string | | false |
37-
| policies | List of violated compliance policies | list | | false |
38-
| primary | Is application primary | boolean | | false |
39-
| production_protected | Application Production Protected counts | ApplicationServerProtectionResource | | false |
40-
| protect | Application data related to Protect | ApplicationProtectResource | | false |
41-
| roles | List of Allowed Roles | collection | | false |
42-
| routes | Application Route Coverage Metrics | RouteCoverageMetricsResource | | false |
43-
| routingFrameworks | Application routing frameworks data | ApplicationRoutingFrameworkResource | | false |
44-
| scores | Application scores | ScoreResource | | false |
45-
| serversWithoutDefend | Has servers without protection enabled | boolean | | false |
46-
| short_name | Short name | string | | false |
47-
| size | Total LoC | long | | false |
48-
| size_shorthand | Total LoC shorthand | string | | false |
49-
| status | Application status | string | | false |
50-
| tags | List of tags | list | | false |
51-
| techs | List of techs | list | | false |
52-
| total_modules | Number of app modules | long | | false |
53-
| trace_breakdown | Application vulnerability breakdown | TraceBreakdownResource | | false |
54-
| trace_severity_breakdown | Application vulnerability severity breakdown | collection | | false |
55-
| validationErrorFields | List of fields with validation errors | list | | false |
8+
| appId | | string | | false |
9+
| appName | | string | | false |
10+
| appDisplayName | | string | | false |
11+
| appArchived | | boolean | | false |
12+
| appContext | | string | | false |
13+
| parentAppId | | string | | false |
14+
| appLanguage | | agentlanguage | | false |
5615
### Template
5716
```
58-
{"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":[]}
17+
{"appArchived":true,"appContext":"","appDisplayName":"","appId":"","appLanguage":"","appName":"","parentAppId":""}
5918
```
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
```
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/BaseApiFormResponse.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ Base API form Response
77
| ---- | ----------- | ---- | -------------- | -------- |
88
| success | Indicates whether API response was successful or not | boolean | | false |
99
| messages | List of messages | list | | false |
10-
| errors | List of errors | list | | false |
1110
### Template
1211
```
13-
{"errors":[],"messages":[],"success":true}
12+
{"messages":[],"success":true}
1413
```

saas-restapi-v3/objects/BaseApiResponse.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ Base API 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 |
10-
| success | Indicates whether API response was successful or not | boolean | | false |
8+
| success | Indicates whether API response was successful or not | boolean | | true |
9+
| messages | List of messages | list | | true |
1110
### Template
1211
```
13-
{"errors":[],"messages":[],"success":true}
12+
{"messages":[],"success":true}
1413
```

0 commit comments

Comments
 (0)