diff --git a/hugo/config/_default/menus/api.en.yaml b/hugo/config/_default/menus/api.en.yaml index 08f1bbed72d..a7bb7673c46 100644 --- a/hugo/config/_default/menus/api.en.yaml +++ b/hugo/config/_default/menus/api.en.yaml @@ -18220,14 +18220,14 @@ menu: unstable: - v2 order: 1 - - name: RUM Retention Quota - url: /api/latest/rum-retention-quota/ - identifier: rum-retention-quota + - name: RUM Retention Quotas + url: /api/latest/rum-retention-quotas/ + identifier: rum-retention-quotas generated: true - name: Create or update a RUM retention quota config - url: /api/latest/rum-retention-quota/create-or-update-a-rum-retention-quota-config/ - identifier: rum-retention-quota-create-or-update-a-rum-retention-quota-config - parent: rum-retention-quota + url: /api/latest/rum-retention-quotas/create-or-update-a-rum-retention-quota-config/ + identifier: rum-retention-quotas-create-or-update-a-rum-retention-quota-config + parent: rum-retention-quotas generated: true params: versions: @@ -18237,9 +18237,9 @@ menu: unstable: [] order: 2 - name: Get a RUM retention quota configuration - url: /api/latest/rum-retention-quota/get-a-rum-retention-quota-configuration/ - identifier: rum-retention-quota-get-a-rum-retention-quota-configuration - parent: rum-retention-quota + url: /api/latest/rum-retention-quotas/get-a-rum-retention-quota-configuration/ + identifier: rum-retention-quotas-get-a-rum-retention-quota-configuration + parent: rum-retention-quotas generated: true params: versions: @@ -18249,9 +18249,9 @@ menu: unstable: [] order: 1 - name: Delete a RUM retention quota configuration - url: /api/latest/rum-retention-quota/delete-a-rum-retention-quota-configuration/ - identifier: rum-retention-quota-delete-a-rum-retention-quota-configuration - parent: rum-retention-quota + url: /api/latest/rum-retention-quotas/delete-a-rum-retention-quota-configuration/ + identifier: rum-retention-quotas-delete-a-rum-retention-quota-configuration + parent: rum-retention-quotas generated: true params: versions: diff --git a/hugo/content/en/api/latest/rum-retention-quotas/_index.md b/hugo/content/en/api/latest/rum-retention-quotas/_index.md new file mode 100644 index 00000000000..64a72c84aa3 --- /dev/null +++ b/hugo/content/en/api/latest/rum-retention-quotas/_index.md @@ -0,0 +1,3 @@ +--- +title: RUM Retention Quotas +--- diff --git a/hugo/content/en/api/latest/rum-retention-quotas/create-or-update-a-rum-retention-quota-config/index.md b/hugo/content/en/api/latest/rum-retention-quotas/create-or-update-a-rum-retention-quota-config/index.md new file mode 100644 index 00000000000..837e5a01f6c --- /dev/null +++ b/hugo/content/en/api/latest/rum-retention-quotas/create-or-update-a-rum-retention-quota-config/index.md @@ -0,0 +1,3 @@ +--- +title: Create or update a RUM retention quota config +--- diff --git a/hugo/content/en/api/latest/rum-retention-quotas/delete-a-rum-retention-quota-configuration/index.md b/hugo/content/en/api/latest/rum-retention-quotas/delete-a-rum-retention-quota-configuration/index.md new file mode 100644 index 00000000000..252840ab322 --- /dev/null +++ b/hugo/content/en/api/latest/rum-retention-quotas/delete-a-rum-retention-quota-configuration/index.md @@ -0,0 +1,3 @@ +--- +title: Delete a RUM retention quota configuration +--- diff --git a/hugo/content/en/api/latest/rum-retention-quotas/get-a-rum-retention-quota-configuration/index.md b/hugo/content/en/api/latest/rum-retention-quotas/get-a-rum-retention-quota-configuration/index.md new file mode 100644 index 00000000000..02cb984e4c3 --- /dev/null +++ b/hugo/content/en/api/latest/rum-retention-quotas/get-a-rum-retention-quota-configuration/index.md @@ -0,0 +1,3 @@ +--- +title: Get a RUM retention quota configuration +--- diff --git a/hugo/content/en/api/v2/rum-retention-quotas/_index.md b/hugo/content/en/api/v2/rum-retention-quotas/_index.md new file mode 100644 index 00000000000..143375b9c22 --- /dev/null +++ b/hugo/content/en/api/v2/rum-retention-quotas/_index.md @@ -0,0 +1,4 @@ +--- +title: RUM Retention Quotas +headless: true +--- diff --git a/hugo/content/en/api/v2/rum-retention-quotas/examples.json b/hugo/content/en/api/v2/rum-retention-quotas/examples.json new file mode 100644 index 00000000000..d0ec39561c2 --- /dev/null +++ b/hugo/content/en/api/v2/rum-retention-quotas/examples.json @@ -0,0 +1,343 @@ +{ + "DeleteRumQuotaConfig": { + "responses": { + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetRumQuotaConfig": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "custom": { + "daily_reset_time": "08:00", + "daily_reset_timezone": "+09:00", + "quota_reached_action": "stop", + "session_limit": 1000000, + "window_type": "daily" + }, + "mode": "custom", + "org_id": 2, + "updated_at": "2026-03-04T15:37:54.951447Z", + "updated_by": "test@example.com" + }, + "id": "cd73a516-a481-4af5-8352-9b577465c77b", + "type": "rum_quota_config" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The RUM retention quota configuration object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The RUM retention quota configuration properties.

\n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

The configuration used when mode is custom.

\n
\n
\n
\n
\n
\n

daily_reset_time [required]

\n
\n

string

\n

The time of day when the daily quota resets, in HH:MM 24-hour format.

\n
\n \n
\n
\n
\n
\n
\n

daily_reset_timezone [required]

\n
\n

string

\n

The timezone offset used for the daily reset time, in ±HH:MM format.

\n
\n \n
\n
\n
\n
\n
\n

quota_reached_action [required]

\n
\n

enum

\n

The action to take when the session quota is reached. \nAllowed enum values: stop,slowdown

\n
\n \n
\n
\n
\n
\n
\n

session_limit [required]

\n
\n

int64

\n

The maximum number of sessions allowed within the window. Must be at least 1000.

\n
\n \n
\n
\n
\n
\n
\n

window_type [required]

\n
\n

enum

\n

The window type over which the session limit is enforced. \nAllowed enum values: daily

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

mode [required]

\n
\n

enum

\n

The retention quota mode. custom enforces a fixed session limit.\ncustom is the only supported mode. \nAllowed enum values: custom

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization the retention quota configuration belongs to.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The date the retention quota configuration was last updated.

\n
\n \n
\n
\n
\n
\n
\n

updated_by

\n
\n

string

\n

The handle of the user who last updated the retention quota configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The identifier of the scope the retention quota configuration applies to.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource, always rum_quota_config. \nAllowed enum values: rum_quota_config

default: rum_quota_config

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpsertRumQuotaConfig": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "custom": { + "daily_reset_time": "08:00", + "daily_reset_timezone": "+09:00", + "quota_reached_action": "stop", + "session_limit": 1000000, + "window_type": "daily" + }, + "mode": "custom", + "org_id": 2, + "updated_at": "2026-03-04T15:37:54.951447Z", + "updated_by": "test@example.com" + }, + "id": "cd73a516-a481-4af5-8352-9b577465c77b", + "type": "rum_quota_config" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The RUM retention quota configuration object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The RUM retention quota configuration properties.

\n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

The configuration used when mode is custom.

\n
\n
\n
\n
\n
\n

daily_reset_time [required]

\n
\n

string

\n

The time of day when the daily quota resets, in HH:MM 24-hour format.

\n
\n \n
\n
\n
\n
\n
\n

daily_reset_timezone [required]

\n
\n

string

\n

The timezone offset used for the daily reset time, in ±HH:MM format.

\n
\n \n
\n
\n
\n
\n
\n

quota_reached_action [required]

\n
\n

enum

\n

The action to take when the session quota is reached. \nAllowed enum values: stop,slowdown

\n
\n \n
\n
\n
\n
\n
\n

session_limit [required]

\n
\n

int64

\n

The maximum number of sessions allowed within the window. Must be at least 1000.

\n
\n \n
\n
\n
\n
\n
\n

window_type [required]

\n
\n

enum

\n

The window type over which the session limit is enforced. \nAllowed enum values: daily

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

mode [required]

\n
\n

enum

\n

The retention quota mode. custom enforces a fixed session limit.\ncustom is the only supported mode. \nAllowed enum values: custom

\n
\n \n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization the retention quota configuration belongs to.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

date-time

\n

The date the retention quota configuration was last updated.

\n
\n \n
\n
\n
\n
\n
\n

updated_by

\n
\n

string

\n

The handle of the user who last updated the retention quota configuration.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The identifier of the scope the retention quota configuration applies to.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource, always rum_quota_config. \nAllowed enum values: rum_quota_config

default: rum_quota_config

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "custom": { + "daily_reset_time": "08:00", + "daily_reset_timezone": "+09:00", + "quota_reached_action": "stop", + "session_limit": 1000000, + "window_type": "daily" + }, + "mode": "custom" + }, + "id": "cd73a516-a481-4af5-8352-9b577465c77b", + "type": "rum_quota_config" + } + }, + "json": { + "data": { + "attributes": { + "custom": { + "daily_reset_time": "08:00", + "daily_reset_timezone": "+09:00", + "quota_reached_action": "stop", + "session_limit": 1000000, + "window_type": "daily" + }, + "mode": "custom" + }, + "id": "cd73a516-a481-4af5-8352-9b577465c77b", + "type": "rum_quota_config" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The RUM retention quota configuration to create or update.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The RUM retention quota configuration properties to create or update.

\n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

The configuration used when mode is custom.

\n
\n
\n
\n
\n
\n

daily_reset_time [required]

\n
\n

string

\n

The time of day when the daily quota resets, in HH:MM 24-hour format.

\n
\n \n
\n
\n
\n
\n
\n

daily_reset_timezone [required]

\n
\n

string

\n

The timezone offset used for the daily reset time, in ±HH:MM format.

\n
\n \n
\n
\n
\n
\n
\n

quota_reached_action [required]

\n
\n

enum

\n

The action to take when the session quota is reached. \nAllowed enum values: stop,slowdown

\n
\n \n
\n
\n
\n
\n
\n

session_limit [required]

\n
\n

int64

\n

The maximum number of sessions allowed within the window. Must be at least 1000.

\n
\n \n
\n
\n
\n
\n
\n

window_type [required]

\n
\n

enum

\n

The window type over which the session limit is enforced. \nAllowed enum values: daily

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

mode [required]

\n
\n

enum

\n

The retention quota mode. custom enforces a fixed session limit.\ncustom is the only supported mode. \nAllowed enum values: custom

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The identifier of the scope the retention quota configuration applies to.\nMust match scope_id in the path.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The type of the resource, always rum_quota_config. \nAllowed enum values: rum_quota_config

default: rum_quota_config

\n
\n \n
\n
\n
\n
" + } + } +} \ No newline at end of file diff --git a/hugo/data/api/v2/full_spec.yaml b/hugo/data/api/v2/full_spec.yaml index 82c19cafb65..3b0cff1c101 100644 --- a/hugo/data/api/v2/full_spec.yaml +++ b/hugo/data/api/v2/full_spec.yaml @@ -1799,7 +1799,9 @@ components: example: cd73a516-a481-4af5-8352-9b577465c77b type: string RumRetentionQuotaScopeTypeParameter: - description: The type of scope the retention quota configuration applies to. + description: |- + The type of scope the retention quota configuration applies to. + `application` is the only supported scope type. in: path name: scope_type required: true @@ -93793,25 +93795,9 @@ components: $ref: "#/components/schemas/RumRetentionFilterData" type: array type: object - RumRetentionQuotaAdaptiveConfig: - description: The configuration used when `mode` is `adaptive`. - properties: - max_retention_rate: - description: The maximum fraction of sessions to retain, in the range `(0, 1]`. - example: 0.5 - exclusiveMinimum: true - format: double - maximum: 1 - minimum: 0 - type: number - required: - - max_retention_rate - type: object RumRetentionQuotaConfigAttributes: description: The RUM retention quota configuration properties. properties: - adaptive: - $ref: "#/components/schemas/RumRetentionQuotaAdaptiveConfig" custom: $ref: "#/components/schemas/RumRetentionQuotaCustomConfig" mode: @@ -93869,8 +93855,6 @@ components: RumRetentionQuotaConfigUpdateAttributes: description: The RUM retention quota configuration properties to create or update. properties: - adaptive: - $ref: "#/components/schemas/RumRetentionQuotaAdaptiveConfig" custom: $ref: "#/components/schemas/RumRetentionQuotaCustomConfig" mode: @@ -93936,14 +93920,13 @@ components: type: object RumRetentionQuotaMode: description: |- - The retention quota mode. `custom` enforces a fixed session limit, while - `adaptive` dynamically adjusts retention. + The retention quota mode. `custom` enforces a fixed session limit. + `custom` is the only supported mode. enum: - custom - - adaptive example: custom type: string - x-enum-varnames: ["CUSTOM", "ADAPTIVE"] + x-enum-varnames: ["CUSTOM"] RumRetentionQuotaReachedAction: description: The action to take when the session quota is reached. enum: @@ -93954,7 +93937,9 @@ components: x-enum-varnames: ["STOP", "SLOWDOWN"] RumRetentionQuotaScopeType: default: application - description: The type of scope the retention quota configuration applies to. + description: |- + The type of scope the retention quota configuration applies to. + `application` is the only supported scope type. enum: - application example: application @@ -190320,7 +190305,7 @@ paths: $ref: "#/components/responses/TooManyRequestsResponse" summary: Delete a RUM retention quota configuration tags: - - RUM Retention Quota + - RUM Retention Quotas x-menu-order: 3 x-permission: operator: OR @@ -190384,7 +190369,7 @@ paths: $ref: "#/components/responses/TooManyRequestsResponse" summary: Get a RUM retention quota configuration tags: - - RUM Retention Quota + - RUM Retention Quotas x-menu-order: 1 x-permission: operator: OR @@ -190471,7 +190456,7 @@ paths: $ref: "#/components/responses/TooManyRequestsResponse" summary: Create or update a RUM retention quota config tags: - - RUM Retention Quota + - RUM Retention Quotas x-codegen-request-body-name: body x-menu-order: 2 x-permission: @@ -223209,7 +223194,7 @@ tags: name: RUM Remote Config - description: |- Manage RUM retention quota configurations for your organization's RUM applications. - name: RUM Retention Quota + name: RUM Retention Quotas - description: View and manage Reference Tables in your organization. name: Reference Tables - description: |- diff --git a/hugo/data/api/v2/translate_tags.json b/hugo/data/api/v2/translate_tags.json index 8ba7761da2d..7b0cd881892 100644 --- a/hugo/data/api/v2/translate_tags.json +++ b/hugo/data/api/v2/translate_tags.json @@ -395,8 +395,8 @@ "name": "RUM Remote Config", "description": "Manage [RUM SDK configurations](https://docs.datadoghq.com/real_user_monitoring/) delivered to RUM applications via Remote Configuration." }, - "rum-retention-quota": { - "name": "RUM Retention Quota", + "rum-retention-quotas": { + "name": "RUM Retention Quotas", "description": "Manage RUM retention quota configurations for your organization's RUM applications." }, "reference-tables": {