rum
Creates, updates, deletes, gets or lists a rum resource.
Overview
| Name | rum |
| Type | Resource |
| Id | cloudflare.zones.rum |
Fields
The following fields are returned by SELECT queries:
- list
Rum Status.
| Name | Datatype | Description |
|---|---|---|
id | string | (example: rum) |
editable | boolean | |
value | string | Current state of RUM. Returns On, Off, or Manual. (example: on) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | zone_id | Retrieves RUM status for a zone. | |
web_analytics_toggle_rum | update | zone_id | Toggles RUM on/off for an existing zone. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
zone_id | string | The Cloudflare zone ID. |
SELECT examples
- list
Retrieves RUM status for a zone.
SELECT
id,
editable,
value
FROM cloudflare.zones.rum
WHERE zone_id = '{{ zone_id }}' -- required
;
UPDATE examples
- web_analytics_toggle_rum
Toggles RUM on/off for an existing zone.
UPDATE cloudflare.zones.rum
SET
value = '{{ value }}'
WHERE
zone_id = '{{ zone_id }}' --required
RETURNING
errors,
messages,
result,
success;