@@ -1656,6 +1656,7 @@ paths:
1656
1656
- $ref : ' parameters.yaml#/ParamIncludeFilters'
1657
1657
- $ref : ' parameters.yaml#/ParamIncludeRemediations'
1658
1658
- $ref : ' parameters.yaml#/ParamIncludeRemediationItems'
1659
+ - $ref : ' parameters.yaml#/ParamIncludeSummary'
1659
1660
- $ref : ' parameters.yaml#/ParamLimit'
1660
1661
- $ref : ' parameters.yaml#/ParamScopeTrue'
1661
1662
- $ref : ' parameters.yaml#/ParamSort'
@@ -1792,6 +1793,8 @@ paths:
1792
1793
$ref : parameters.yaml#/IncludeRemediations
1793
1794
include_remediation_items :
1794
1795
$ref : parameters.yaml#/IncludeRemediationItems
1796
+ include_summary :
1797
+ $ref : parameters.yaml#/IncludeSummary
1795
1798
limit :
1796
1799
$ref : parameters.yaml#/ExposuresLimit
1797
1800
scope :
@@ -1921,7 +1924,7 @@ paths:
1921
1924
schema :
1922
1925
$ref : schemas.yaml#/QueryExposuresResponse
1923
1926
examples :
1924
- ' Exposures (include_filters=false, include_exposures=false) ' :
1927
+ ' Exposures (include_filters=false, include_exposures=false, include_summary=false ) ' :
1925
1928
$ref : examples.yaml#/QueryExposuresExample
1926
1929
' Exposures for whole account (details=true, include_filters=true) ' :
1927
1930
$ref : examples.yaml#/QueryExposuresWholeAccountExample
@@ -1951,6 +1954,61 @@ paths:
1951
1954
$ref : responses.yaml#/NotFound
1952
1955
' 503 ' :
1953
1956
$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
+
1954
2012
/assets_query/v2/{account_id}/remediation-items :
1955
2013
parameters :
1956
2014
- $ref : ' parameters.yaml#/UrlParamAccountId'
0 commit comments