v1
latestOpenAPI 3.0.02026-07-141,4077,1665.2 MBRum Retention Filters
Update a permanent RUM retention filter
Update the cross-product sampling configuration of a permanent RUM retention filter for a RUM application. Only fields marked as editable in the editability block of the filter can be updated. Updating a non-editable field returns a 400 response.
patch/api/v2/rum/applications/{app_id}/retention_filters/permanent/{permanent_rf_id}
Path parameters
app_idstring required
RUM application ID.
permanent_rf_id'rum_apm_flat_sampling' | 'synthetics_sessions' | 'forced_replay_sessions' required
The identifier of a permanent RUM retention filter.
Example:synthetics_sessions
The identifier of the permanent RUM retention filter.
Request body
Example request
{
"data": {
"attributes": {
"cross_product_sampling": {
"trace_enabled": true,
"trace_sample_rate": 25
}
},
"id": "synthetics_sessions",
"type": "permanent_retention_filters"
}
}Response
Updated
Example response
{
"data": {
"attributes": {
"cross_product_sampling": {
"trace_enabled": true,
"trace_sample_rate": 25
},
"description": "All sessions generated by Synthetics are retained at 100%.",
"editability": {
"trace_editable": true
},
"name": "Synthetics Sessions"
},
"id": "synthetics_sessions",
"type": "permanent_retention_filters"
}
}