Skip to content

Add OpenAPI spec for RUM Remote Config endpoints #3699

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

Merged
api-clients-generation-pipeline merged 1 commit into from
Jun 18, 2026
Merged

Add OpenAPI spec for RUM Remote Config endpoints #3699

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
514 changes: 514 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 @@ -690,6 +690,13 @@ datadog\_api\_client.v2.api.rum\_rate\_limit\_api module
:members:
:show-inheritance:

datadog\_api\_client.v2.api.rum\_remote\_config\_api module
-----------------------------------------------------------

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

datadog\_api\_client.v2.api.rum\_replay\_heatmaps\_api module
-------------------------------------------------------------

Expand Down
140 changes: 140 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 @@ -34213,6 +34213,146 @@ datadog\_api\_client.v2.model.rum\_retention\_filters\_response module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.rum\_sdk\_config\_attributes module
-----------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_data module
-----------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_dynamic\_option module
----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_dynamic\_option\_pair module
----------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_dynamic\_option\_serialized\_type module
----------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_dynamic\_option\_strategy module
--------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_match\_option module
--------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_match\_option\_serialized\_type module
--------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_meta module
-----------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_response module
---------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_rum\_attributes module
----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_rum\_update\_attributes module
------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_serialized\_regex module
------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_serialized\_regex\_type module
------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_tracing\_url\_config module
---------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_tracing\_url\_propagator\_type module
-------------------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_type module
-----------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_update\_attributes module
-------------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_update\_data module
-------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_sdk\_config\_update\_request module
----------------------------------------------------------------------

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

datadog\_api\_client.v2.model.rum\_search\_events\_request module
-----------------------------------------------------------------

Expand Down
16 changes: 16 additions & 0 deletions examples/v2/rum-remote-config/GetRumSdkConfig.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
"""
Get a RUM SDK configuration returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.rum_remote_config_api import RUMRemoteConfigApi

configuration = Configuration()
configuration.unstable_operations["get_rum_sdk_config"] = True
with ApiClient(configuration) as api_client:
api_instance = RUMRemoteConfigApi(api_client)
response = api_instance.get_rum_sdk_config(
config_id="config_id",
)

print(response)
119 changes: 119 additions & 0 deletions examples/v2/rum-remote-config/UpdateRumSdkConfig.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
"""
Update a RUM SDK configuration returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.rum_remote_config_api import RUMRemoteConfigApi
from datadog_api_client.v2.model.rum_sdk_config_dynamic_option import RumSdkConfigDynamicOption
from datadog_api_client.v2.model.rum_sdk_config_dynamic_option_pair import RumSdkConfigDynamicOptionPair
from datadog_api_client.v2.model.rum_sdk_config_dynamic_option_serialized_type import (
RumSdkConfigDynamicOptionSerializedType,
)
from datadog_api_client.v2.model.rum_sdk_config_dynamic_option_strategy import RumSdkConfigDynamicOptionStrategy
from datadog_api_client.v2.model.rum_sdk_config_match_option import RumSdkConfigMatchOption
from datadog_api_client.v2.model.rum_sdk_config_match_option_serialized_type import (
RumSdkConfigMatchOptionSerializedType,
)
from datadog_api_client.v2.model.rum_sdk_config_rum_update_attributes import RumSdkConfigRumUpdateAttributes
from datadog_api_client.v2.model.rum_sdk_config_serialized_regex import RumSdkConfigSerializedRegex
from datadog_api_client.v2.model.rum_sdk_config_serialized_regex_type import RumSdkConfigSerializedRegexType
from datadog_api_client.v2.model.rum_sdk_config_tracing_url_config import RumSdkConfigTracingUrlConfig
from datadog_api_client.v2.model.rum_sdk_config_tracing_url_propagator_type import RumSdkConfigTracingUrlPropagatorType
from datadog_api_client.v2.model.rum_sdk_config_type import RumSdkConfigType
from datadog_api_client.v2.model.rum_sdk_config_update_attributes import RumSdkConfigUpdateAttributes
from datadog_api_client.v2.model.rum_sdk_config_update_data import RumSdkConfigUpdateData
from datadog_api_client.v2.model.rum_sdk_config_update_request import RumSdkConfigUpdateRequest

body = RumSdkConfigUpdateRequest(
data=RumSdkConfigUpdateData(
attributes=RumSdkConfigUpdateAttributes(
rum=RumSdkConfigRumUpdateAttributes(
allowed_tracing_urls=[
RumSdkConfigTracingUrlConfig(
match=RumSdkConfigMatchOption(
rc_serialized_type=RumSdkConfigMatchOptionSerializedType.STRING,
value="https://app.datadoghq.com",
),
propagator_types=[
RumSdkConfigTracingUrlPropagatorType.DATADOG,
RumSdkConfigTracingUrlPropagatorType.TRACECONTEXT,
],
),
],
allowed_tracking_origins=[
RumSdkConfigMatchOption(
rc_serialized_type=RumSdkConfigMatchOptionSerializedType.STRING,
value="https://app.datadoghq.com",
),
],
context=[
RumSdkConfigDynamicOptionPair(
key="id",
value=RumSdkConfigDynamicOption(
attribute="data-version",
extractor=RumSdkConfigSerializedRegex(
rc_serialized_type=RumSdkConfigSerializedRegexType.REGEX,
value="^https://app-.*.datadoghq.com",
),
key="app.version",
name="app_version",
path="application.version",
rc_serialized_type=RumSdkConfigDynamicOptionSerializedType.DYNAMIC,
selector="#app-version",
strategy=RumSdkConfigDynamicOptionStrategy.JS,
),
),
],
default_privacy_level="mask",
enable_privacy_for_action_name=True,
env="production",
service="my-service",
session_replay_sample_rate=20,
session_sample_rate=75,
trace_sample_rate=100,
track_session_across_subdomains=False,
user=[
RumSdkConfigDynamicOptionPair(
key="id",
value=RumSdkConfigDynamicOption(
attribute="data-version",
extractor=RumSdkConfigSerializedRegex(
rc_serialized_type=RumSdkConfigSerializedRegexType.REGEX,
value="^https://app-.*.datadoghq.com",
),
key="app.version",
name="app_version",
path="application.version",
rc_serialized_type=RumSdkConfigDynamicOptionSerializedType.DYNAMIC,
selector="#app-version",
strategy=RumSdkConfigDynamicOptionStrategy.JS,
),
),
],
version=RumSdkConfigDynamicOption(
attribute="data-version",
extractor=RumSdkConfigSerializedRegex(
rc_serialized_type=RumSdkConfigSerializedRegexType.REGEX,
value="^https://app-.*.datadoghq.com",
),
key="app.version",
name="app_version",
path="application.version",
rc_serialized_type=RumSdkConfigDynamicOptionSerializedType.DYNAMIC,
selector="#app-version",
strategy=RumSdkConfigDynamicOptionStrategy.JS,
),
),
),
id="abc12345-1234-5678-abcd-ef1234567890",
type=RumSdkConfigType.RUM_SDK_CONFIG,
),
)

configuration = Configuration()
configuration.unstable_operations["update_rum_sdk_config"] = True
with ApiClient(configuration) as api_client:
api_instance = RUMRemoteConfigApi(api_client)
response = api_instance.update_rum_sdk_config(config_id="config_id", body=body)

print(response)
2 changes: 2 additions & 0 deletions src/datadog_api_client/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -692,6 +692,8 @@ def __init__(
"v2.get_pruned_trace_by_id": False,
"v2.get_trace_by_id": False,
"v2.get_asm_service_by_name": False,
"v2.get_rum_sdk_config": False,
"v2.update_rum_sdk_config": False,
"v2.create_report_schedule": False,
"v2.patch_report_schedule": False,
"v2.delete_sourcemaps": False,
Expand Down
Loading
Loading