Skip to content

document agentless GCP scan options CRUD endpoints #2879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

document agentless GCP scan options CRUD endpoints #2879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
341 changes: 326 additions & 15 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

63 changes: 63 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8236,6 +8236,69 @@ datadog\_api\_client.v2.model.gcp\_monitored\_resource\_config\_type module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.gcp\_scan\_options module
-------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.gcp_scan_options
:members:
:show-inheritance:

datadog\_api\_client.v2.model.gcp\_scan\_options\_array module
--------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.gcp_scan_options_array
:members:
:show-inheritance:

datadog\_api\_client.v2.model.gcp\_scan\_options\_data module
-------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.gcp_scan_options_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.gcp\_scan\_options\_data\_attributes module
-------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.gcp_scan_options_data_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.gcp\_scan\_options\_data\_type module
-------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.gcp_scan_options_data_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.gcp\_scan\_options\_input\_update module
----------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.gcp_scan_options_input_update
:members:
:show-inheritance:

datadog\_api\_client.v2.model.gcp\_scan\_options\_input\_update\_data module
----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.gcp_scan_options_input_update_data
:members:
:show-inheritance:

datadog\_api\_client.v2.model.gcp\_scan\_options\_input\_update\_data\_attributes module
----------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.gcp_scan_options_input_update_data_attributes
:members:
:show-inheritance:

datadog\_api\_client.v2.model.gcp\_scan\_options\_input\_update\_data\_type module
----------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.gcp_scan_options_input_update_data_type
:members:
:show-inheritance:

datadog\_api\_client.v2.model.gcp\_service\_account module
----------------------------------------------------------

Expand Down
28 changes: 28 additions & 0 deletions examples/v2/agentless-scanning/CreateGcpScanOptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
"""
Post GCP Scan Options returns "Agentless scan options enabled successfully." response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.agentless_scanning_api import AgentlessScanningApi
from datadog_api_client.v2.model.gcp_scan_options import GcpScanOptions
from datadog_api_client.v2.model.gcp_scan_options_data import GcpScanOptionsData
from datadog_api_client.v2.model.gcp_scan_options_data_attributes import GcpScanOptionsDataAttributes
from datadog_api_client.v2.model.gcp_scan_options_data_type import GcpScanOptionsDataType

body = GcpScanOptions(
data=GcpScanOptionsData(
id="new-project",
type=GcpScanOptionsDataType.GCP_SCAN_OPTIONS,
attributes=GcpScanOptionsDataAttributes(
vuln_host_os=True,
vuln_containers_os=True,
),
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = AgentlessScanningApi(api_client)
response = api_instance.create_gcp_scan_options(body=body)

print(response)
13 changes: 13 additions & 0 deletions examples/v2/agentless-scanning/DeleteGcpScanOptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
"""
Delete GCP Scan Options returns "No Content" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.agentless_scanning_api import AgentlessScanningApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = AgentlessScanningApi(api_client)
api_instance.delete_gcp_scan_options(
project_id="company-project-id",
)
15 changes: 15 additions & 0 deletions examples/v2/agentless-scanning/GetAzureScanOptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
"""
Get Azure scan options returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.agentless_scanning_api import AgentlessScanningApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = AgentlessScanningApi(api_client)
response = api_instance.get_azure_scan_options(
subscription_id="12345678-90ab-cdef-1234-567890abcdef",
)

print(response)
15 changes: 15 additions & 0 deletions examples/v2/agentless-scanning/GetGcpScanOptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
"""
Get GCP scan options returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.agentless_scanning_api import AgentlessScanningApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = AgentlessScanningApi(api_client)
response = api_instance.get_gcp_scan_options(
project_id="api-spec-test",
)

print(response)
13 changes: 13 additions & 0 deletions examples/v2/agentless-scanning/ListGcpScanOptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
"""
List GCP Scan Options returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.agentless_scanning_api import AgentlessScanningApi

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = AgentlessScanningApi(api_client)
response = api_instance.list_gcp_scan_options()

print(response)
29 changes: 29 additions & 0 deletions examples/v2/agentless-scanning/UpdateGcpScanOptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
"""
Patch GCP Scan Options returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.agentless_scanning_api import AgentlessScanningApi
from datadog_api_client.v2.model.gcp_scan_options_input_update import GcpScanOptionsInputUpdate
from datadog_api_client.v2.model.gcp_scan_options_input_update_data import GcpScanOptionsInputUpdateData
from datadog_api_client.v2.model.gcp_scan_options_input_update_data_attributes import (
GcpScanOptionsInputUpdateDataAttributes,
)
from datadog_api_client.v2.model.gcp_scan_options_input_update_data_type import GcpScanOptionsInputUpdateDataType

body = GcpScanOptionsInputUpdate(
data=GcpScanOptionsInputUpdateData(
id="api-spec-test",
type=GcpScanOptionsInputUpdateDataType.GCP_SCAN_OPTIONS,
attributes=GcpScanOptionsInputUpdateDataAttributes(
vuln_containers_os=False,
),
),
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = AgentlessScanningApi(api_client)
response = api_instance.update_gcp_scan_options(project_id="api-spec-test", body=body)

print(response)
Loading