Skip to content

Commit 128e500

Browse files
author
CI bot
committed
Definitions Update remediations
2 parents 0fd0838 + 6e25e16 commit 128e500

File tree

4 files changed

+93
-9
lines changed

4 files changed

+93
-9
lines changed

alsdkdefs/apis/remediations/assets_query.v1.yaml

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1656,6 +1656,7 @@ paths:
16561656
- $ref: 'parameters.yaml#/ParamIncludeFilters'
16571657
- $ref: 'parameters.yaml#/ParamIncludeRemediations'
16581658
- $ref: 'parameters.yaml#/ParamIncludeRemediationItems'
1659+
- $ref: 'parameters.yaml#/ParamIncludeSummary'
16591660
- $ref: 'parameters.yaml#/ParamLimit'
16601661
- $ref: 'parameters.yaml#/ParamScopeTrue'
16611662
- $ref: 'parameters.yaml#/ParamSort'
@@ -1792,6 +1793,8 @@ paths:
17921793
$ref: parameters.yaml#/IncludeRemediations
17931794
include_remediation_items:
17941795
$ref: parameters.yaml#/IncludeRemediationItems
1796+
include_summary:
1797+
$ref: parameters.yaml#/IncludeSummary
17951798
limit:
17961799
$ref: parameters.yaml#/ExposuresLimit
17971800
scope:
@@ -1921,7 +1924,7 @@ paths:
19211924
schema:
19221925
$ref: schemas.yaml#/QueryExposuresResponse
19231926
examples:
1924-
'Exposures (include_filters=false, include_exposures=false)':
1927+
'Exposures (include_filters=false, include_exposures=false, include_summary=false)':
19251928
$ref: examples.yaml#/QueryExposuresExample
19261929
'Exposures for whole account (details=true, include_filters=true)':
19271930
$ref: examples.yaml#/QueryExposuresWholeAccountExample
@@ -1951,6 +1954,61 @@ paths:
19511954
$ref: responses.yaml#/NotFound
19521955
'503':
19531956
$ref: responses.yaml#/UnavailableError
1957+
1958+
/assets_query/v2/{account_id}/exposure-filters:
1959+
parameters:
1960+
- $ref: 'parameters.yaml#/UrlParamAccountId'
1961+
get:
1962+
operationId: query_exposure_filters
1963+
summary: Query Exposure Filters
1964+
description: |-
1965+
Groups vulnerabilities for an account by exposure or remediation, then returns filters.
1966+
Only returns five filter properties if available: `deployment_id`, `deployment_name`, `key`, `name` and `type`.
1967+
1968+
Exposure Filters can be reduced using the `filter` parameter in the query string. The `filter` param
1969+
can be used multiple times and filters supplied will limit the returned filters to those related to vulnerabilities
1970+
that match all supplied filters. The [remediation filters](#section/Remediation-filters) documented in the Usage
1971+
section are allowed.
1972+
tags:
1973+
- Exposures and Remediations
1974+
parameters:
1975+
- $ref: 'parameters.yaml#/ParamQueryExposuresFilter'
1976+
x-codeSamples:
1977+
- lang: Shell
1978+
label: Basic exposure-filters query
1979+
source: |-
1980+
curl "https://api.cloudinsight.alertlogic.com/assets_query/v2/12345678/exposure-filters" \
1981+
-H "x-aims-auth-token: $TOKEN" -H "accept: application/json"
1982+
- lang: Shell
1983+
label: Exposure Filters with include_filter false
1984+
source: |-
1985+
curl "https://api.cloudinsight.alertlogic.com/assets_query/v2/12345678/exposure-filters?include_filters=false" \
1986+
-H "x-aims-auth-token: $TOKEN" -H "accept: application/json"
1987+
responses:
1988+
"200":
1989+
description: OK
1990+
content:
1991+
application/json:
1992+
schema:
1993+
$ref: 'schemas.yaml#/QueryExposureFiltersResponse'
1994+
examples:
1995+
Exposure filters:
1996+
$ref: 'examples.yaml#/QueryExposureFiltersExample'
1997+
Exposures for whole account (include_filters=false):
1998+
$ref: 'examples.yaml#/QueryExposureFiltersExample'
1999+
"400":
2000+
$ref: 'responses.yaml#/InvalidValueError'
2001+
"401":
2002+
$ref: 'responses.yaml#/Unauthorized'
2003+
"403":
2004+
$ref: 'responses.yaml#/Forbidden'
2005+
"404":
2006+
$ref: 'responses.yaml#/NotFound'
2007+
"503":
2008+
$ref: 'responses.yaml#/UnavailableError'
2009+
security:
2010+
- x-aims-auth-token: [ ]
2011+
19542012
/assets_query/v2/{account_id}/remediation-items:
19552013
parameters:
19562014
- $ref: 'parameters.yaml#/UrlParamAccountId'

alsdkdefs/apis/remediations/examples.yaml

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2652,15 +2652,9 @@ QueryExposuresExample:
26522652
filters: []
26532653
exposures:
26542654
assets: []
2655-
rows: 1
2655+
rows: 0
26562656
exposures_count: 0
2657-
summary:
2658-
severities:
2659-
all: 1
2660-
high: 1
2661-
info: 0
2662-
low: 0
2663-
medium: 0
2657+
summary: {}
26642658
QueryExposuresWholeAccountExample:
26652659
value:
26662660
filters:
@@ -3365,6 +3359,20 @@ QueryExposuresMostVulnerableAssetsExample:
33653359
info: 0
33663360
low: 0
33673361
medium: 0
3362+
QueryExposureFiltersExample:
3363+
value:
3364+
filters:
3365+
- key: security
3366+
type: category
3367+
- deployment_id: 814C2911-09BB-1005-9916-7831C1BAC182
3368+
deployment_name: Test Deployment 1
3369+
key: 814C2911-09BB-1005-9916-7831C1BAC182
3370+
name: Test Deployment 1
3371+
type: deployment_id
3372+
- key: aws
3373+
type: deployment_type
3374+
- key: high
3375+
type: severity
33683376
QueryTopologyExample:
33693377
value:
33703378
topology:

alsdkdefs/apis/remediations/parameters.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -425,6 +425,15 @@ IncludeRemediationItems:
425425
type: boolean
426426
default: false
427427
description: Controls whether `remediation_items` are returned in the response body.
428+
ParamIncludeSummary:
429+
schema:
430+
$ref: '#/IncludeSummary'
431+
in: query
432+
name: include_summary
433+
IncludeSummary:
434+
type: boolean
435+
default: true
436+
description: Controls whether `summary` is returned in the response body.
428437
ParamIncludeExposures:
429438
schema:
430439
$ref: '#/IncludeExposures'

alsdkdefs/apis/remediations/schemas.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,15 @@ QueryExposuresResponse:
381381
type: integer
382382
medium:
383383
type: integer
384+
QueryExposureFiltersResponse:
385+
title: Query exposure filters response
386+
type: object
387+
properties:
388+
filters:
389+
type: array
390+
items:
391+
type: object
392+
description: Filter item.
384393
QueryRemediationItemsResponse:
385394
title: Query remediation-items response
386395
type: object

0 commit comments

Comments
 (0)