@@ -1633,7 +1633,8 @@ paths:
1633
1633
operationId : query_exposures
1634
1634
summary : Query Exposures
1635
1635
description : |-
1636
- Groups vulnerabilities for an account by exposure (by default), remediation, or vulnerable asset.
1636
+ Groups vulnerabilities for an account by remediation (by default), exposure, or vulnerable asset and returns
1637
+ paginated items if `page_size` is provided.
1637
1638
In combination with filtering, it's easy to view vulnerabilities across your account in the manner
1638
1639
most appropriate.
1639
1640
@@ -1647,6 +1648,7 @@ paths:
1647
1648
- Exposures and Remediations
1648
1649
parameters :
1649
1650
- $ref : ' parameters.yaml#/ParamConcluded'
1651
+ - $ref : ' parameters.yaml#/ParamContinue'
1650
1652
- $ref : ' parameters.yaml#/ParamQueryExposuresBasicDetails'
1651
1653
- $ref : ' parameters.yaml#/ParamQueryExposuresDetails'
1652
1654
- $ref : ' parameters.yaml#/ParamDisposed'
@@ -1658,14 +1660,26 @@ paths:
1658
1660
- $ref : ' parameters.yaml#/ParamIncludeRemediationItems'
1659
1661
- $ref : ' parameters.yaml#/ParamIncludeSummary'
1660
1662
- $ref : ' parameters.yaml#/ParamLimit'
1663
+ - $ref : ' parameters.yaml#/ParamPageSize'
1661
1664
- $ref : ' parameters.yaml#/ParamScopeTrue'
1662
1665
- $ref : ' parameters.yaml#/ParamSort'
1666
+ - $ref : ' parameters.yaml#/ParamSearch'
1663
1667
x-codeSamples :
1664
1668
- lang : Shell
1665
1669
label : Basic exposures query
1666
1670
source : |-
1667
1671
curl "https://api.cloudinsight.alertlogic.com/assets_query/v2/12345678/exposures" \
1668
1672
-H "x-aims-auth-token: $TOKEN" -H "accept: application/json"
1673
+ - lang : Shell
1674
+ label : Exposures with page_size 1
1675
+ source : |-
1676
+ curl "https://api.cloudinsight.alertlogic.com/assets_query/v2/12345678/exposures?page_size=1" \
1677
+ -H "x-aims-auth-token: $TOKEN" -H "accept: application/json"
1678
+ - lang : Shell
1679
+ label : Exposures with continue
1680
+ source : |-
1681
+ curl "https://api.cloudinsight.alertlogic.com/assets_query/v2/12345678/exposures?continue=g2gDZAATb2Zmc2V0X2NvbnRpbnVhdGlvbmwAAAADaAJtAAAABm9mZnNldGEBaAJtAAAAD2luY2x1ZGVfZmlsdGVyc20AAAAFZmFsc2VoAm0AAAAJcGFnZV9zaXplbQAAAAExamEC" \
1682
+ -H "x-aims-auth-token: $TOKEN" -H "accept: application/json"
1669
1683
- lang : Shell
1670
1684
label : Exposures with filter by deployment ID
1671
1685
source : |-
@@ -1711,6 +1725,16 @@ paths:
1711
1725
source : |-
1712
1726
curl "https://api.cloudinsight.alertlogic.com/assets_query/v2/12345678/exposures?group=asset&filter=asset_type:host" \
1713
1727
-H "x-aims-auth-token: $TOKEN" -H "accept: application/json"
1728
+ - lang : Shell
1729
+ label : Exposures filtered via search string
1730
+ source : |-
1731
+ curl "https://api.cloudinsight.alertlogic.com/assets_query/v2/12345678/exposures?search=CVE-2016-5387" \
1732
+ -H "x-aims-auth-token: $TOKEN" -H "accept: application/json"
1733
+ - lang : Shell
1734
+ label : Remediations sorted by Name ascending
1735
+ source : |-
1736
+ curl "https://api.cloudinsight.alertlogic.com/assets_query/v2/12345678/exposures?sort=name:asc" \
1737
+ -H "x-aims-auth-token: $TOKEN" -H "accept: application/json"
1714
1738
responses :
1715
1739
" 200 " :
1716
1740
description : OK
@@ -1725,6 +1749,10 @@ paths:
1725
1749
$ref : ' examples.yaml#/QueryExposuresWholeAccountExample'
1726
1750
Exposures for specific deployment ID (details=false, include_filters=true) :
1727
1751
$ref : ' examples.yaml#/QueryExposuresSpecificDeploymentExample'
1752
+ Exposures with page_size (page_size=1) :
1753
+ $ref : ' examples.yaml#/QueryExposuresWithPagination'
1754
+ Exposures with continue (continue=g2gDZAATb2Zmc2V0X2NvbnRpbnVhdGlvbmwAAAADaAJtAAAABm9mZnNldGEBaAJtAAAAD2luY2x1ZGVfZmlsdGVyc20AAAAFZmFsc2VoAm0AAAAJcGFnZV9zaXplbQAAAAExamEC) :
1755
+ $ref : ' examples.yaml#/QueryExposuresWithPaginationContinue'
1728
1756
Remediations (include_filters=false, include_remediations=false) :
1729
1757
$ref : ' examples.yaml#/QueryExposuresRemediationsExample'
1730
1758
Remediations for whole account (details=true, include_filters=true, include_remediation_items=true) :
@@ -1739,6 +1767,10 @@ paths:
1739
1767
$ref : ' examples.yaml#/QueryExposuresVulnerableAssetsSpecificDeploymentExample'
1740
1768
Most vulnerable assets by type (group=asset, filter=asset_type:host, limit=2) :
1741
1769
$ref : ' examples.yaml#/QueryExposuresMostVulnerableAssetsExample'
1770
+ Exposures filtered via search string :
1771
+ $ref : ' examples.yaml#/QueryExposuresSearch'
1772
+ Remediations sorted by Name ascending :
1773
+ $ref : ' examples.yaml#/QueryExposuresSortedByNameExample'
1742
1774
" 400 " :
1743
1775
$ref : ' responses.yaml#/InvalidValueError'
1744
1776
" 401 " :
@@ -1755,7 +1787,8 @@ paths:
1755
1787
summary : Query Exposures
1756
1788
operationId : query_exposures_post
1757
1789
description : |-
1758
- Groups vulnerabilities for an account by exposure (by default), remediation, or vulnerable asset.
1790
+ Groups vulnerabilities for an account by remediation (by default), exposure, or vulnerable asset and returns
1791
+ paginated items if `page_size` is provided.
1759
1792
In combination with filtering, it's easy to view vulnerabilities across your account in the manner
1760
1793
most appropriate.
1761
1794
@@ -1775,6 +1808,8 @@ paths:
1775
1808
properties :
1776
1809
concluded :
1777
1810
$ref : parameters.yaml#/ExposuresConcluded
1811
+ continue :
1812
+ $ref : parameters.yaml#/ExposuresContinue
1778
1813
basic_details :
1779
1814
$ref : parameters.yaml#/ExposuresBasicDetails
1780
1815
details :
@@ -1797,10 +1832,14 @@ paths:
1797
1832
$ref : parameters.yaml#/IncludeSummary
1798
1833
limit :
1799
1834
$ref : parameters.yaml#/ExposuresLimit
1835
+ page_size :
1836
+ $ref : parameters.yaml#/ExposuresPageSize
1800
1837
scope :
1801
1838
$ref : parameters.yaml#/ScopeTrue
1802
1839
sort :
1803
1840
$ref : parameters.yaml#/ExposuresSort
1841
+ search :
1842
+ $ref : parameters.yaml#/ExposuresSearch
1804
1843
security :
1805
1844
- x-aims-auth-token : []
1806
1845
x-codeSamples :
@@ -1811,6 +1850,24 @@ paths:
1811
1850
-X POST -H "x-aims-auth-token: $TOKEN" -H "accept: application/json" -d@- << EOF
1812
1851
{}
1813
1852
EOF
1853
+ - lang : Shell
1854
+ label : Exposures with page_size 1
1855
+ source : |-
1856
+ curl "https://api.cloudinsight.alertlogic.com/assets_query/v2/12345678/exposures" \
1857
+ -X POST -H "x-aims-auth-token: $TOKEN" -H "accept: application/json" -d@- << EOF
1858
+ {
1859
+ "page_size": "1"
1860
+ }
1861
+ EOF
1862
+ - lang : Shell
1863
+ label : Exposures with continue
1864
+ source : |-
1865
+ curl "https://api.cloudinsight.alertlogic.com/assets_query/v2/12345678/exposures" \
1866
+ -X POST -H "x-aims-auth-token: $TOKEN" -H "accept: application/json" -d@- << EOF
1867
+ {
1868
+ "continue": "g2gDZAATb2Zmc2V0X2NvbnRpbnVhdGlvbmwAAAADaAJtAAAABm9mZnNldGEBaAJtAAAAD2luY2x1ZGVfZmlsdGVyc20AAAAFZmFsc2VoAm0AAAAJcGFnZV9zaXplbQAAAAExamEC"
1869
+ }
1870
+ EOF
1814
1871
- lang : Shell
1815
1872
label : Exposures with filter by deployment ID
1816
1873
source : |-
@@ -1916,6 +1973,24 @@ paths:
1916
1973
"group": "asset"
1917
1974
}
1918
1975
EOF
1976
+ - lang : Shell
1977
+ label : Exposures filtered via search string
1978
+ source : |-
1979
+ curl "https://api.cloudinsight.alertlogic.com/assets_query/v2/12345678/exposures" \
1980
+ -X POST -H "x-aims-auth-token: $TOKEN" -H "accept: application/json" -d@- << EOF
1981
+ {
1982
+ "search": "CVE-2016-5387"
1983
+ }
1984
+ EOF
1985
+ - lang : Shell
1986
+ label : Remediations sorted by Name ascending
1987
+ source : |-
1988
+ curl "https://api.cloudinsight.alertlogic.com/assets_query/v2/12345678/exposures" \
1989
+ -X POST -H "x-aims-auth-token: $TOKEN" -H "accept: application/json" -d@- << EOF
1990
+ {
1991
+ "sort": "name:asc"
1992
+ }
1993
+ EOF
1919
1994
responses :
1920
1995
' 200 ' :
1921
1996
description : OK
@@ -1930,6 +2005,10 @@ paths:
1930
2005
$ref : examples.yaml#/QueryExposuresWholeAccountExample
1931
2006
' Exposures for specific deployment ID (details=false, include_filters=true) ' :
1932
2007
$ref : examples.yaml#/QueryExposuresSpecificDeploymentExample
2008
+ ' Exposures with page_size (page_size=1) ' :
2009
+ $ref : examples.yaml#/QueryExposuresWithPagination
2010
+ ' Exposures with continue (continue=g2gDZAATb2Zmc2V0X2NvbnRpbnVhdGlvbmwAAAADaAJtAAAABm9mZnNldGEBaAJtAAAAD2luY2x1ZGVfZmlsdGVyc20AAAAFZmFsc2VoAm0AAAAJcGFnZV9zaXplbQAAAAExamEC) ' :
2011
+ $ref : examples.yaml#/QueryExposuresWithPaginationContinue
1933
2012
' Remediations (include_filters=false, include_remediations=false) ' :
1934
2013
$ref : examples.yaml#/QueryExposuresRemediationsExample
1935
2014
' Remediations for whole account (details=true, include_filters=true, include_remediation_items=true) ' :
@@ -1944,6 +2023,10 @@ paths:
1944
2023
$ref : examples.yaml#/QueryExposuresVulnerableAssetsSpecificDeploymentExample
1945
2024
' Most vulnerable assets by type (group=asset, filter=asset_type:host, limit=2) ' :
1946
2025
$ref : examples.yaml#/QueryExposuresMostVulnerableAssetsExample
2026
+ ' Exposures filtered via search string ' :
2027
+ $ref : examples.yaml#/QueryExposuresSearch
2028
+ ' Remediations sorted by Name ascending ' :
2029
+ $ref : examples.yaml#/QueryExposuresSortedByNameExample
1947
2030
' 400 ' :
1948
2031
$ref : responses.yaml#/InvalidValueError
1949
2032
' 401 ' :
0 commit comments