Skip to content

Update a RUM application.

PUT
/rum/{app_id}
curl --request PUT \
--url https://api.siteqwality.com/rum/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "domain": "example", "settings": { "privacy": { "mask_inputs": true, "mask_text": true }, "retention": { "observe_days": 1, "analyze_days": 1 } } }'
app_id
required
string format: uuid

RUM application identifier

Media type application/json
object
name
string | null
domain
string | null
settings
One of:
null
Example generated
{
"name": "example",
"domain": "example",
"settings": {
"privacy": {
"mask_inputs": true,
"mask_text": true
},
"retention": {
"observe_days": 1,
"analyze_days": 1
}
}
}

RUM application updated

Media type application/json
object
id
required
string format: uuid
account_id
required
string format: uuid
name
required
string
domain
string | null
client_token
required
string
settings
required
object
privacy
object
mask_inputs

Mask the value of every form input before it leaves the browser. Defaults to ON.

boolean
mask_text

Mask all user-visible page text. Defaults to OFF: a replay with every text node masked is unreadable, so this is opt-in. Anything the page renders is therefore recorded verbatim unless the customer turns this on, and every document that describes replay has to say so.

boolean
retention

The customer’s own maximum retention for this application’s data, in days. Absent, and by default, means no limit beyond the account’s entitlement. See common::retention::ceiling: the entitlement is a MAX over the account’s packs, which makes every window a floor, and this is the only thing that lets a customer go below it.

object
observe_days

Caps rum_measures (RUM Observe), the 458-day table.

integer | null format: int32
analyze_days

Caps rum_events (RUM Analyze).

integer | null format: int32
created_at
required
string format: date-time
updated_at
required
string format: date-time
Example generated
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"account_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"domain": "example",
"client_token": "example",
"settings": {
"privacy": {
"mask_inputs": true,
"mask_text": true
},
"retention": {
"observe_days": 1,
"analyze_days": 1
}
},
"created_at": "2026-04-15T12:00:00Z",
"updated_at": "2026-04-15T12:00:00Z"
}

Invalid request body

Missing or invalid authentication

Application not found

Internal server error