Skip to content

Add public Execution Policies endpoints #3875

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

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add public Execution Policies endpoints #3875

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
753 changes: 753 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions docs/datadog_api_client.v2.api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,13 @@ datadog\_api\_client.v2.api.events\_api module
:members:
:show-inheritance:

datadog\_api\_client.v2.api.execution\_policy\_api module
---------------------------------------------------------

.. automodule:: datadog_api_client.v2.api.execution_policy_api
:members:
:show-inheritance:

datadog\_api\_client.v2.api.fastly\_integration\_api module
-----------------------------------------------------------

Expand Down
168 changes: 168 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 @@ -15194,6 +15194,174 @@ datadog\_api\_client.v2.model.events\_warning module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.execution\_policy\_action\_pattern module
-----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_attributes module
------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_create\_request module
-----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_create\_request\_data module
-----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_effect module
--------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_integration module
-------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_kubernetes\_scope module
-------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_kubernetes\_scope\_rule module
-------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_list\_response module
----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_list\_response\_meta module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_list\_response\_page module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_remote\_action\_rshell\_access module
--------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_remote\_action\_rshell\_scope module
-------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_remote\_action\_rshell\_scope\_rule module
-------------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_response module
----------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_response\_data module
----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_scope module
-------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_script\_scope module
---------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_script\_scope\_rule module
---------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_target module
--------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_type module
------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_update\_request module
-----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_update\_request\_data module
-----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.execution\_policy\_write\_attributes module
-------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.exposure\_rollout\_step\_request module
---------------------------------------------------------------------

Expand Down
37 changes: 37 additions & 0 deletions examples/v2/execution-policy/CreateExecutionPolicy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
"""
Create an execution policy returns "Created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.execution_policy_api import ExecutionPolicyApi
from datadog_api_client.v2.model.execution_policy_action_pattern import ExecutionPolicyActionPattern
from datadog_api_client.v2.model.execution_policy_create_request import ExecutionPolicyCreateRequest
from datadog_api_client.v2.model.execution_policy_create_request_data import ExecutionPolicyCreateRequestData
from datadog_api_client.v2.model.execution_policy_effect import ExecutionPolicyEffect
from datadog_api_client.v2.model.execution_policy_integration import ExecutionPolicyIntegration
from datadog_api_client.v2.model.execution_policy_type import ExecutionPolicyType
from datadog_api_client.v2.model.execution_policy_write_attributes import ExecutionPolicyWriteAttributes

body = ExecutionPolicyCreateRequest(
data=ExecutionPolicyCreateRequestData(
type=ExecutionPolicyType.EXECUTION_POLICY,
attributes=ExecutionPolicyWriteAttributes(
name="Cassette Execution Policy exampleexecutionpolicy",
effect=ExecutionPolicyEffect.ALLOW,
action_pattern=ExecutionPolicyActionPattern(
integration=ExecutionPolicyIntegration.INTEGRATION_SCRIPT,
action_fqns=[
"com.datadoghq.script.*",
],
),
),
),
)

configuration = Configuration()
configuration.unstable_operations["create_execution_policy"] = True
with ApiClient(configuration) as api_client:
api_instance = ExecutionPolicyApi(api_client)
response = api_instance.create_execution_policy(body=body)

print(response)
60 changes: 60 additions & 0 deletions examples/v2/execution-policy/CreateExecutionPolicy_1075977289.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
"""
Create an execution policy with scope and targets returns "Created" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.execution_policy_api import ExecutionPolicyApi
from datadog_api_client.v2.model.execution_policy_action_pattern import ExecutionPolicyActionPattern
from datadog_api_client.v2.model.execution_policy_create_request import ExecutionPolicyCreateRequest
from datadog_api_client.v2.model.execution_policy_create_request_data import ExecutionPolicyCreateRequestData
from datadog_api_client.v2.model.execution_policy_effect import ExecutionPolicyEffect
from datadog_api_client.v2.model.execution_policy_integration import ExecutionPolicyIntegration
from datadog_api_client.v2.model.execution_policy_scope import ExecutionPolicyScope
from datadog_api_client.v2.model.execution_policy_script_scope import ExecutionPolicyScriptScope
from datadog_api_client.v2.model.execution_policy_script_scope_rule import ExecutionPolicyScriptScopeRule
from datadog_api_client.v2.model.execution_policy_target import ExecutionPolicyTarget
from datadog_api_client.v2.model.execution_policy_type import ExecutionPolicyType
from datadog_api_client.v2.model.execution_policy_write_attributes import ExecutionPolicyWriteAttributes

body = ExecutionPolicyCreateRequest(
data=ExecutionPolicyCreateRequestData(
type=ExecutionPolicyType.EXECUTION_POLICY,
attributes=ExecutionPolicyWriteAttributes(
name="Cassette Execution Policy exampleexecutionpolicy",
effect=ExecutionPolicyEffect.ALLOW,
action_pattern=ExecutionPolicyActionPattern(
integration=ExecutionPolicyIntegration.INTEGRATION_SCRIPT,
action_fqns=[
"com.datadoghq.script.*",
],
),
scope=ExecutionPolicyScope(
scripts=ExecutionPolicyScriptScope(
rules=[
ExecutionPolicyScriptScopeRule(
target_script_names=[
"restart_service.sh",
],
),
],
),
),
targets=[
ExecutionPolicyTarget(
name="Production hosts",
agent_tags=[
"env:prod",
],
),
],
),
),
)

configuration = Configuration()
configuration.unstable_operations["create_execution_policy"] = True
with ApiClient(configuration) as api_client:
api_instance = ExecutionPolicyApi(api_client)
response = api_instance.create_execution_policy(body=body)

print(response)
18 changes: 18 additions & 0 deletions examples/v2/execution-policy/DeleteExecutionPolicy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
"""
Delete an execution policy returns "No Content" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.execution_policy_api import ExecutionPolicyApi

# there is a valid "execution_policy" in the system
EXECUTION_POLICY_DATA_ID = environ["EXECUTION_POLICY_DATA_ID"]

configuration = Configuration()
configuration.unstable_operations["delete_execution_policy"] = True
with ApiClient(configuration) as api_client:
api_instance = ExecutionPolicyApi(api_client)
api_instance.delete_execution_policy(
policy_id=EXECUTION_POLICY_DATA_ID,
)
20 changes: 20 additions & 0 deletions examples/v2/execution-policy/GetExecutionPolicy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
"""
Get an execution policy returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.execution_policy_api import ExecutionPolicyApi

# there is a valid "execution_policy" in the system
EXECUTION_POLICY_DATA_ID = environ["EXECUTION_POLICY_DATA_ID"]

configuration = Configuration()
configuration.unstable_operations["get_execution_policy"] = True
with ApiClient(configuration) as api_client:
api_instance = ExecutionPolicyApi(api_client)
response = api_instance.get_execution_policy(
policy_id=EXECUTION_POLICY_DATA_ID,
)

print(response)
14 changes: 14 additions & 0 deletions examples/v2/execution-policy/ListExecutionPolicies.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
"""
List execution policies returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.execution_policy_api import ExecutionPolicyApi

configuration = Configuration()
configuration.unstable_operations["list_execution_policies"] = True
with ApiClient(configuration) as api_client:
api_instance = ExecutionPolicyApi(api_client)
response = api_instance.list_execution_policies()

print(response)
41 changes: 41 additions & 0 deletions examples/v2/execution-policy/ListExecutionPolicies_1745885519.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
"""
List execution policies with query parameters returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.execution_policy_api import ExecutionPolicyApi
from datadog_api_client.v2.model.execution_policy_effect import ExecutionPolicyEffect
from datadog_api_client.v2.model.execution_policy_integration import ExecutionPolicyIntegration

# there is a valid "execution_policy" in the system
EXECUTION_POLICY_DATA_ATTRIBUTES_CREATED_BY = environ["EXECUTION_POLICY_DATA_ATTRIBUTES_CREATED_BY"]
EXECUTION_POLICY_DATA_ATTRIBUTES_NAME = environ["EXECUTION_POLICY_DATA_ATTRIBUTES_NAME"]
EXECUTION_POLICY_DATA_ID = environ["EXECUTION_POLICY_DATA_ID"]

configuration = Configuration()
configuration.unstable_operations["list_execution_policies"] = True
with ApiClient(configuration) as api_client:
api_instance = ExecutionPolicyApi(api_client)
response = api_instance.list_execution_policies(
page_size=10,
page_number=0,
filter_name=EXECUTION_POLICY_DATA_ATTRIBUTES_NAME,
filter_ids=[
EXECUTION_POLICY_DATA_ID,
],
filter_integration=[
ExecutionPolicyIntegration.INTEGRATION_SCRIPT,
],
filter_effects=[
ExecutionPolicyEffect.ALLOW,
],
filter_creator_ids=[
EXECUTION_POLICY_DATA_ATTRIBUTES_CREATED_BY,
],
sort=[
"-created_at",
],
)

print(response)
Loading
Loading