Skip to content

Commit c84f7b4

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
document agentless GCP scan options CRUD endpoints (#2883)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent b0d5e30 commit c84f7b4

File tree

85 files changed

+1714
-63
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+1714
-63
lines changed

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 326 additions & 15 deletions
Large diffs are not rendered by default.

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8236,6 +8236,69 @@ datadog\_api\_client.v2.model.gcp\_monitored\_resource\_config\_type module
82368236
:members:
82378237
:show-inheritance:
82388238

8239+
datadog\_api\_client.v2.model.gcp\_scan\_options module
8240+
-------------------------------------------------------
8241+
8242+
.. automodule:: datadog_api_client.v2.model.gcp_scan_options
8243+
:members:
8244+
:show-inheritance:
8245+
8246+
datadog\_api\_client.v2.model.gcp\_scan\_options\_array module
8247+
--------------------------------------------------------------
8248+
8249+
.. automodule:: datadog_api_client.v2.model.gcp_scan_options_array
8250+
:members:
8251+
:show-inheritance:
8252+
8253+
datadog\_api\_client.v2.model.gcp\_scan\_options\_data module
8254+
-------------------------------------------------------------
8255+
8256+
.. automodule:: datadog_api_client.v2.model.gcp_scan_options_data
8257+
:members:
8258+
:show-inheritance:
8259+
8260+
datadog\_api\_client.v2.model.gcp\_scan\_options\_data\_attributes module
8261+
-------------------------------------------------------------------------
8262+
8263+
.. automodule:: datadog_api_client.v2.model.gcp_scan_options_data_attributes
8264+
:members:
8265+
:show-inheritance:
8266+
8267+
datadog\_api\_client.v2.model.gcp\_scan\_options\_data\_type module
8268+
-------------------------------------------------------------------
8269+
8270+
.. automodule:: datadog_api_client.v2.model.gcp_scan_options_data_type
8271+
:members:
8272+
:show-inheritance:
8273+
8274+
datadog\_api\_client.v2.model.gcp\_scan\_options\_input\_update module
8275+
----------------------------------------------------------------------
8276+
8277+
.. automodule:: datadog_api_client.v2.model.gcp_scan_options_input_update
8278+
:members:
8279+
:show-inheritance:
8280+
8281+
datadog\_api\_client.v2.model.gcp\_scan\_options\_input\_update\_data module
8282+
----------------------------------------------------------------------------
8283+
8284+
.. automodule:: datadog_api_client.v2.model.gcp_scan_options_input_update_data
8285+
:members:
8286+
:show-inheritance:
8287+
8288+
datadog\_api\_client.v2.model.gcp\_scan\_options\_input\_update\_data\_attributes module
8289+
----------------------------------------------------------------------------------------
8290+
8291+
.. automodule:: datadog_api_client.v2.model.gcp_scan_options_input_update_data_attributes
8292+
:members:
8293+
:show-inheritance:
8294+
8295+
datadog\_api\_client.v2.model.gcp\_scan\_options\_input\_update\_data\_type module
8296+
----------------------------------------------------------------------------------
8297+
8298+
.. automodule:: datadog_api_client.v2.model.gcp_scan_options_input_update_data_type
8299+
:members:
8300+
:show-inheritance:
8301+
82398302
datadog\_api\_client.v2.model.gcp\_service\_account module
82408303
----------------------------------------------------------
82418304

‎examples/v2/agentless-scanning/CreateGcpScanOptions.py‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
"""
2+
Post GCP Scan Options returns "Agentless scan options enabled successfully." response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.agentless_scanning_api import AgentlessScanningApi
7+
from datadog_api_client.v2.model.gcp_scan_options import GcpScanOptions
8+
from datadog_api_client.v2.model.gcp_scan_options_data import GcpScanOptionsData
9+
from datadog_api_client.v2.model.gcp_scan_options_data_attributes import GcpScanOptionsDataAttributes
10+
from datadog_api_client.v2.model.gcp_scan_options_data_type import GcpScanOptionsDataType
11+
12+
body = GcpScanOptions(
13+
data=GcpScanOptionsData(
14+
id="new-project",
15+
type=GcpScanOptionsDataType.GCP_SCAN_OPTIONS,
16+
attributes=GcpScanOptionsDataAttributes(
17+
vuln_host_os=True,
18+
vuln_containers_os=True,
19+
),
20+
),
21+
)
22+
23+
configuration = Configuration()
24+
with ApiClient(configuration) as api_client:
25+
api_instance = AgentlessScanningApi(api_client)
26+
response = api_instance.create_gcp_scan_options(body=body)
27+
28+
print(response)

‎examples/v2/agentless-scanning/DeleteGcpScanOptions.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
"""
2+
Delete GCP Scan Options returns "No Content" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.agentless_scanning_api import AgentlessScanningApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = AgentlessScanningApi(api_client)
11+
api_instance.delete_gcp_scan_options(
12+
project_id="company-project-id",
13+
)

‎examples/v2/agentless-scanning/GetAzureScanOptions.py‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
"""
2+
Get Azure scan options returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.agentless_scanning_api import AgentlessScanningApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = AgentlessScanningApi(api_client)
11+
response = api_instance.get_azure_scan_options(
12+
subscription_id="12345678-90ab-cdef-1234-567890abcdef",
13+
)
14+
15+
print(response)

‎examples/v2/agentless-scanning/GetGcpScanOptions.py‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
"""
2+
Get GCP scan options returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.agentless_scanning_api import AgentlessScanningApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = AgentlessScanningApi(api_client)
11+
response = api_instance.get_gcp_scan_options(
12+
project_id="api-spec-test",
13+
)
14+
15+
print(response)

‎examples/v2/agentless-scanning/ListGcpScanOptions.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
"""
2+
List GCP Scan Options returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.agentless_scanning_api import AgentlessScanningApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = AgentlessScanningApi(api_client)
11+
response = api_instance.list_gcp_scan_options()
12+
13+
print(response)

‎examples/v2/agentless-scanning/UpdateGcpScanOptions.py‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
"""
2+
Patch GCP Scan Options returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.agentless_scanning_api import AgentlessScanningApi
7+
from datadog_api_client.v2.model.gcp_scan_options_input_update import GcpScanOptionsInputUpdate
8+
from datadog_api_client.v2.model.gcp_scan_options_input_update_data import GcpScanOptionsInputUpdateData
9+
from datadog_api_client.v2.model.gcp_scan_options_input_update_data_attributes import (
10+
GcpScanOptionsInputUpdateDataAttributes,
11+
)
12+
from datadog_api_client.v2.model.gcp_scan_options_input_update_data_type import GcpScanOptionsInputUpdateDataType
13+
14+
body = GcpScanOptionsInputUpdate(
15+
data=GcpScanOptionsInputUpdateData(
16+
id="api-spec-test",
17+
type=GcpScanOptionsInputUpdateDataType.GCP_SCAN_OPTIONS,
18+
attributes=GcpScanOptionsInputUpdateDataAttributes(
19+
vuln_containers_os=False,
20+
),
21+
),
22+
)
23+
24+
configuration = Configuration()
25+
with ApiClient(configuration) as api_client:
26+
api_instance = AgentlessScanningApi(api_client)
27+
response = api_instance.update_gcp_scan_options(project_id="api-spec-test", body=body)
28+
29+
print(response)

0 commit comments

Comments
 (0)