Skip to content

Commit 5ef970a

Browse files
author
CI bot
committed
Definitions Update remediations
2 parents a7d6af5 + 0cf784c commit 5ef970a

File tree

4 files changed

+478
-17
lines changed

4 files changed

+478
-17
lines changed

alsdkdefs/apis/remediations/assets_query.v1.yaml

Lines changed: 85 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1633,7 +1633,8 @@ paths:
16331633
operationId: query_exposures
16341634
summary: Query Exposures
16351635
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.
16371638
In combination with filtering, it's easy to view vulnerabilities across your account in the manner
16381639
most appropriate.
16391640
@@ -1647,6 +1648,7 @@ paths:
16471648
- Exposures and Remediations
16481649
parameters:
16491650
- $ref: 'parameters.yaml#/ParamConcluded'
1651+
- $ref: 'parameters.yaml#/ParamContinue'
16501652
- $ref: 'parameters.yaml#/ParamQueryExposuresBasicDetails'
16511653
- $ref: 'parameters.yaml#/ParamQueryExposuresDetails'
16521654
- $ref: 'parameters.yaml#/ParamDisposed'
@@ -1658,14 +1660,26 @@ paths:
16581660
- $ref: 'parameters.yaml#/ParamIncludeRemediationItems'
16591661
- $ref: 'parameters.yaml#/ParamIncludeSummary'
16601662
- $ref: 'parameters.yaml#/ParamLimit'
1663+
- $ref: 'parameters.yaml#/ParamPageSize'
16611664
- $ref: 'parameters.yaml#/ParamScopeTrue'
16621665
- $ref: 'parameters.yaml#/ParamSort'
1666+
- $ref: 'parameters.yaml#/ParamSearch'
16631667
x-codeSamples:
16641668
- lang: Shell
16651669
label: Basic exposures query
16661670
source: |-
16671671
curl "https://api.cloudinsight.alertlogic.com/assets_query/v2/12345678/exposures" \
16681672
-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"
16691683
- lang: Shell
16701684
label: Exposures with filter by deployment ID
16711685
source: |-
@@ -1711,6 +1725,16 @@ paths:
17111725
source: |-
17121726
curl "https://api.cloudinsight.alertlogic.com/assets_query/v2/12345678/exposures?group=asset&filter=asset_type:host" \
17131727
-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"
17141738
responses:
17151739
"200":
17161740
description: OK
@@ -1725,6 +1749,10 @@ paths:
17251749
$ref: 'examples.yaml#/QueryExposuresWholeAccountExample'
17261750
Exposures for specific deployment ID (details=false, include_filters=true):
17271751
$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'
17281756
Remediations (include_filters=false, include_remediations=false):
17291757
$ref: 'examples.yaml#/QueryExposuresRemediationsExample'
17301758
Remediations for whole account (details=true, include_filters=true, include_remediation_items=true):
@@ -1739,6 +1767,10 @@ paths:
17391767
$ref: 'examples.yaml#/QueryExposuresVulnerableAssetsSpecificDeploymentExample'
17401768
Most vulnerable assets by type (group=asset, filter=asset_type:host, limit=2):
17411769
$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'
17421774
"400":
17431775
$ref: 'responses.yaml#/InvalidValueError'
17441776
"401":
@@ -1755,7 +1787,8 @@ paths:
17551787
summary: Query Exposures
17561788
operationId: query_exposures_post
17571789
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.
17591792
In combination with filtering, it's easy to view vulnerabilities across your account in the manner
17601793
most appropriate.
17611794
@@ -1775,6 +1808,8 @@ paths:
17751808
properties:
17761809
concluded:
17771810
$ref: parameters.yaml#/ExposuresConcluded
1811+
continue:
1812+
$ref: parameters.yaml#/ExposuresContinue
17781813
basic_details:
17791814
$ref: parameters.yaml#/ExposuresBasicDetails
17801815
details:
@@ -1797,10 +1832,14 @@ paths:
17971832
$ref: parameters.yaml#/IncludeSummary
17981833
limit:
17991834
$ref: parameters.yaml#/ExposuresLimit
1835+
page_size:
1836+
$ref: parameters.yaml#/ExposuresPageSize
18001837
scope:
18011838
$ref: parameters.yaml#/ScopeTrue
18021839
sort:
18031840
$ref: parameters.yaml#/ExposuresSort
1841+
search:
1842+
$ref: parameters.yaml#/ExposuresSearch
18041843
security:
18051844
- x-aims-auth-token: []
18061845
x-codeSamples:
@@ -1811,6 +1850,24 @@ paths:
18111850
-X POST -H "x-aims-auth-token: $TOKEN" -H "accept: application/json" -d@- << EOF
18121851
{}
18131852
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
18141871
- lang: Shell
18151872
label: Exposures with filter by deployment ID
18161873
source: |-
@@ -1916,6 +1973,24 @@ paths:
19161973
"group": "asset"
19171974
}
19181975
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
19191994
responses:
19201995
'200':
19211996
description: OK
@@ -1930,6 +2005,10 @@ paths:
19302005
$ref: examples.yaml#/QueryExposuresWholeAccountExample
19312006
'Exposures for specific deployment ID (details=false, include_filters=true)':
19322007
$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
19332012
'Remediations (include_filters=false, include_remediations=false)':
19342013
$ref: examples.yaml#/QueryExposuresRemediationsExample
19352014
'Remediations for whole account (details=true, include_filters=true, include_remediation_items=true)':
@@ -1944,6 +2023,10 @@ paths:
19442023
$ref: examples.yaml#/QueryExposuresVulnerableAssetsSpecificDeploymentExample
19452024
'Most vulnerable assets by type (group=asset, filter=asset_type:host, limit=2)':
19462025
$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
19472030
'400':
19482031
$ref: responses.yaml#/InvalidValueError
19492032
'401':

0 commit comments

Comments
 (0)