Skip to content

Commit 59cb206

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 36f629d of spec repo
1 parent ecd4a27 commit 59cb206

23 files changed

Lines changed: 2179 additions & 0 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 328 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1565,6 +1565,23 @@ components:
15651565
required: true
15661566
schema:
15671567
$ref: "#/components/schemas/RumPermanentRetentionFilterID"
1568+
RumRateLimitScopeIDParameter:
1569+
description: |-
1570+
The identifier of the scope the rate limit configuration applies to.
1571+
For the `application` scope, this is the RUM application ID.
1572+
in: path
1573+
name: scope_id
1574+
required: true
1575+
schema:
1576+
example: cd73a516-a481-4af5-8352-9b577465c77b
1577+
type: string
1578+
RumRateLimitScopeTypeParameter:
1579+
description: The type of scope the rate limit configuration applies to.
1580+
in: path
1581+
name: scope_type
1582+
required: true
1583+
schema:
1584+
$ref: "#/components/schemas/RumRateLimitScopeType"
15681585
RumRetentionFilterIDParameter:
15691586
description: Retention filter ID.
15701587
in: path
@@ -71652,6 +71669,178 @@ components:
7165271669
$ref: "#/components/schemas/RumPermanentRetentionFilterData"
7165371670
type: array
7165471671
type: object
71672+
RumRateLimitAdaptiveConfig:
71673+
description: The configuration used when `mode` is `adaptive`.
71674+
properties:
71675+
max_retention_rate:
71676+
description: The maximum fraction of sessions to retain, in the range `(0, 1]`.
71677+
example: 0.5
71678+
exclusiveMinimum: 0
71679+
format: double
71680+
maximum: 1
71681+
type: number
71682+
required:
71683+
- max_retention_rate
71684+
type: object
71685+
RumRateLimitConfigAttributes:
71686+
description: The RUM rate limit configuration properties.
71687+
properties:
71688+
adaptive:
71689+
$ref: "#/components/schemas/RumRateLimitAdaptiveConfig"
71690+
custom:
71691+
$ref: "#/components/schemas/RumRateLimitCustomConfig"
71692+
mode:
71693+
$ref: "#/components/schemas/RumRateLimitMode"
71694+
org_id:
71695+
description: The ID of the organization the rate limit configuration belongs to.
71696+
example: 2
71697+
format: int64
71698+
type: integer
71699+
updated_at:
71700+
description: The date the rate limit configuration was last updated.
71701+
example: "2026-03-04T15:37:54.951447Z"
71702+
type: string
71703+
updated_by:
71704+
description: The handle of the user who last updated the rate limit configuration.
71705+
example: test@example.com
71706+
type: string
71707+
required:
71708+
- mode
71709+
- org_id
71710+
type: object
71711+
RumRateLimitConfigData:
71712+
description: The RUM rate limit configuration object.
71713+
properties:
71714+
attributes:
71715+
$ref: "#/components/schemas/RumRateLimitConfigAttributes"
71716+
id:
71717+
description: The identifier of the scope the rate limit configuration applies to.
71718+
example: cd73a516-a481-4af5-8352-9b577465c77b
71719+
type: string
71720+
type:
71721+
$ref: "#/components/schemas/RumRateLimitConfigType"
71722+
required:
71723+
- id
71724+
- type
71725+
- attributes
71726+
type: object
71727+
RumRateLimitConfigResponse:
71728+
description: The RUM rate limit configuration response.
71729+
properties:
71730+
data:
71731+
$ref: "#/components/schemas/RumRateLimitConfigData"
71732+
required:
71733+
- data
71734+
type: object
71735+
RumRateLimitConfigType:
71736+
default: rum_rate_limit_config
71737+
description: The type of the resource, always `rum_rate_limit_config`.
71738+
enum:
71739+
- rum_rate_limit_config
71740+
example: rum_rate_limit_config
71741+
type: string
71742+
x-enum-varnames: ["RUM_RATE_LIMIT_CONFIG"]
71743+
RumRateLimitConfigUpdateAttributes:
71744+
description: The RUM rate limit configuration properties to create or update.
71745+
properties:
71746+
adaptive:
71747+
$ref: "#/components/schemas/RumRateLimitAdaptiveConfig"
71748+
custom:
71749+
$ref: "#/components/schemas/RumRateLimitCustomConfig"
71750+
mode:
71751+
$ref: "#/components/schemas/RumRateLimitMode"
71752+
required:
71753+
- mode
71754+
type: object
71755+
RumRateLimitConfigUpdateData:
71756+
description: The RUM rate limit configuration to create or update.
71757+
properties:
71758+
attributes:
71759+
$ref: "#/components/schemas/RumRateLimitConfigUpdateAttributes"
71760+
id:
71761+
description: |-
71762+
The identifier of the scope the rate limit configuration applies to.
71763+
Must match `scope_id` in the path.
71764+
example: cd73a516-a481-4af5-8352-9b577465c77b
71765+
type: string
71766+
type:
71767+
$ref: "#/components/schemas/RumRateLimitConfigType"
71768+
required:
71769+
- id
71770+
- type
71771+
- attributes
71772+
type: object
71773+
RumRateLimitConfigUpdateRequest:
71774+
description: The body of a request to create or update a RUM rate limit configuration.
71775+
properties:
71776+
data:
71777+
$ref: "#/components/schemas/RumRateLimitConfigUpdateData"
71778+
required:
71779+
- data
71780+
type: object
71781+
RumRateLimitCustomConfig:
71782+
description: The configuration used when `mode` is `custom`.
71783+
properties:
71784+
daily_reset_time:
71785+
description: The time of day when the daily quota resets, in `HH:MM` 24-hour format.
71786+
example: "08:00"
71787+
pattern: "^([01]\\d|2[0-3]):[0-5]\\d$"
71788+
type: string
71789+
daily_reset_timezone:
71790+
description: The timezone offset used for the daily reset time, in `±HH:MM` format.
71791+
example: "+09:00"
71792+
pattern: "^[+-](0\\d|1[0-4]):[0-5]\\d$"
71793+
type: string
71794+
quota_reached_action:
71795+
$ref: "#/components/schemas/RumRateLimitQuotaReachedAction"
71796+
session_limit:
71797+
description: The maximum number of sessions allowed within the window.
71798+
example: 1000000
71799+
format: int64
71800+
minimum: 1
71801+
type: integer
71802+
window_type:
71803+
$ref: "#/components/schemas/RumRateLimitWindowType"
71804+
required:
71805+
- window_type
71806+
- session_limit
71807+
- daily_reset_time
71808+
- daily_reset_timezone
71809+
- quota_reached_action
71810+
type: object
71811+
RumRateLimitMode:
71812+
description: |-
71813+
The rate limit mode. `custom` enforces a fixed session limit, while
71814+
`adaptive` dynamically adjusts retention.
71815+
enum:
71816+
- custom
71817+
- adaptive
71818+
example: custom
71819+
type: string
71820+
x-enum-varnames: ["CUSTOM", "ADAPTIVE"]
71821+
RumRateLimitQuotaReachedAction:
71822+
description: The action to take when the session quota is reached.
71823+
enum:
71824+
- stop
71825+
- slowdown
71826+
example: stop
71827+
type: string
71828+
x-enum-varnames: ["STOP", "SLOWDOWN"]
71829+
RumRateLimitScopeType:
71830+
default: application
71831+
description: The type of scope the rate limit configuration applies to.
71832+
enum:
71833+
- application
71834+
example: application
71835+
type: string
71836+
x-enum-varnames: ["APPLICATION"]
71837+
RumRateLimitWindowType:
71838+
description: The window type over which the session limit is enforced.
71839+
enum:
71840+
- daily
71841+
example: daily
71842+
type: string
71843+
x-enum-varnames: ["DAILY"]
7165571844
RumRetentionFilterAttributes:
7165671845
description: The object describing attributes of a RUM retention filter.
7165771846
properties:
@@ -147474,6 +147663,142 @@ paths:
147474147663
tags:
147475147664
- Rum Metrics
147476147665
x-codegen-request-body-name: body
147666+
/api/v2/rum/config/rate-limit/{scope_type}/{scope_id}:
147667+
delete:
147668+
description: Delete the RUM rate limit configuration for a given scope.
147669+
operationId: DeleteRumRateLimitConfig
147670+
parameters:
147671+
- $ref: "#/components/parameters/RumRateLimitScopeTypeParameter"
147672+
- $ref: "#/components/parameters/RumRateLimitScopeIDParameter"
147673+
responses:
147674+
"204":
147675+
description: No Content
147676+
"400":
147677+
$ref: "#/components/responses/BadRequestResponse"
147678+
"403":
147679+
$ref: "#/components/responses/NotAuthorizedResponse"
147680+
"404":
147681+
$ref: "#/components/responses/NotFoundResponse"
147682+
"429":
147683+
$ref: "#/components/responses/TooManyRequestsResponse"
147684+
summary: Delete a RUM rate limit configuration
147685+
tags:
147686+
- Rum Rate Limit
147687+
x-unstable: |-
147688+
**Note**: This endpoint is in preview and is subject to change.
147689+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
147690+
get:
147691+
description: Get the RUM rate limit configuration for a given scope.
147692+
operationId: GetRumRateLimitConfig
147693+
parameters:
147694+
- $ref: "#/components/parameters/RumRateLimitScopeTypeParameter"
147695+
- $ref: "#/components/parameters/RumRateLimitScopeIDParameter"
147696+
responses:
147697+
"200":
147698+
content:
147699+
application/json:
147700+
examples:
147701+
default:
147702+
value:
147703+
data:
147704+
attributes:
147705+
custom:
147706+
daily_reset_time: "08:00"
147707+
daily_reset_timezone: "+09:00"
147708+
quota_reached_action: stop
147709+
session_limit: 1000000
147710+
window_type: daily
147711+
mode: custom
147712+
org_id: 2
147713+
updated_at: "2026-03-04T15:37:54.951447Z"
147714+
updated_by: test@example.com
147715+
id: cd73a516-a481-4af5-8352-9b577465c77b
147716+
type: rum_rate_limit_config
147717+
schema:
147718+
$ref: "#/components/schemas/RumRateLimitConfigResponse"
147719+
description: OK
147720+
"400":
147721+
$ref: "#/components/responses/BadRequestResponse"
147722+
"403":
147723+
$ref: "#/components/responses/NotAuthorizedResponse"
147724+
"404":
147725+
$ref: "#/components/responses/NotFoundResponse"
147726+
"429":
147727+
$ref: "#/components/responses/TooManyRequestsResponse"
147728+
summary: Get a RUM rate limit configuration
147729+
tags:
147730+
- Rum Rate Limit
147731+
x-unstable: |-
147732+
**Note**: This endpoint is in preview and is subject to change.
147733+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
147734+
put:
147735+
description: |-
147736+
Create or update the RUM rate limit configuration for a given scope.
147737+
Returns the rate limit configuration object when the request is successful.
147738+
operationId: UpdateRumRateLimitConfig
147739+
parameters:
147740+
- $ref: "#/components/parameters/RumRateLimitScopeTypeParameter"
147741+
- $ref: "#/components/parameters/RumRateLimitScopeIDParameter"
147742+
requestBody:
147743+
content:
147744+
application/json:
147745+
examples:
147746+
default:
147747+
value:
147748+
data:
147749+
attributes:
147750+
custom:
147751+
daily_reset_time: "08:00"
147752+
daily_reset_timezone: "+09:00"
147753+
quota_reached_action: stop
147754+
session_limit: 1000000
147755+
window_type: daily
147756+
mode: custom
147757+
id: cd73a516-a481-4af5-8352-9b577465c77b
147758+
type: rum_rate_limit_config
147759+
schema:
147760+
$ref: "#/components/schemas/RumRateLimitConfigUpdateRequest"
147761+
description: The definition of the RUM rate limit configuration to create or update.
147762+
required: true
147763+
responses:
147764+
"200":
147765+
content:
147766+
application/json:
147767+
examples:
147768+
default:
147769+
value:
147770+
data:
147771+
attributes:
147772+
custom:
147773+
daily_reset_time: "08:00"
147774+
daily_reset_timezone: "+09:00"
147775+
quota_reached_action: stop
147776+
session_limit: 1000000
147777+
window_type: daily
147778+
mode: custom
147779+
org_id: 2
147780+
updated_at: "2026-03-04T21:52:53.526022Z"
147781+
updated_by: test@example.com
147782+
id: cd73a516-a481-4af5-8352-9b577465c77b
147783+
type: rum_rate_limit_config
147784+
schema:
147785+
$ref: "#/components/schemas/RumRateLimitConfigResponse"
147786+
description: OK
147787+
"400":
147788+
$ref: "#/components/responses/BadRequestResponse"
147789+
"403":
147790+
$ref: "#/components/responses/NotAuthorizedResponse"
147791+
"404":
147792+
$ref: "#/components/responses/NotFoundResponse"
147793+
"429":
147794+
$ref: "#/components/responses/TooManyRequestsResponse"
147795+
summary: Create or update a RUM rate limit configuration
147796+
tags:
147797+
- Rum Rate Limit
147798+
x-codegen-request-body-name: body
147799+
x-unstable: |-
147800+
**Note**: This endpoint is in preview and is subject to change.
147801+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
147477147802
/api/v2/rum/events:
147478147803
get:
147479147804
description: |-
@@ -171532,6 +171857,9 @@ tags:
171532171857
description: Find out more at
171533171858
url: https://docs.datadoghq.com/real_user_monitoring/platform/generate_metrics/
171534171859
name: Rum Metrics
171860+
- description: |-
171861+
Manage RUM rate limit configurations for your organization's RUM applications.
171862+
name: Rum Rate Limit
171535171863
- description: Manage heatmap snapshots for RUM replay sessions. Create, update, delete, and retrieve snapshots to visualize user interactions on specific views.
171536171864
name: Rum Replay Heatmaps
171537171865
- description: Create and manage playlists of RUM replay sessions. Organize, categorize, and share collections of replay sessions for analysis and collaboration.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Delete a RUM rate limit configuration returns "No Content" response
2+
3+
require "datadog_api_client"
4+
DatadogAPIClient.configure do |config|
5+
config.unstable_operations["v2.delete_rum_rate_limit_config".to_sym] = true
6+
end
7+
api_instance = DatadogAPIClient::V2::RumRateLimitAPI.new
8+
api_instance.delete_rum_rate_limit_config(RumRateLimitScopeType::APPLICATION, "cd73a516-a481-4af5-8352-9b577465c77b")
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Get a RUM rate limit configuration returns "OK" response
2+
3+
require "datadog_api_client"
4+
DatadogAPIClient.configure do |config|
5+
config.unstable_operations["v2.get_rum_rate_limit_config".to_sym] = true
6+
end
7+
api_instance = DatadogAPIClient::V2::RumRateLimitAPI.new
8+
p api_instance.get_rum_rate_limit_config(RumRateLimitScopeType::APPLICATION, "cd73a516-a481-4af5-8352-9b577465c77b")

0 commit comments

Comments
 (0)