Cache policy
Sets the tenant's default cache group and can reset all sites to follow it.
cache-policyCacheAuthentication: User (some parameters admin only)3 endpointsCache policy
GET
/api/v2/cache-policyAuthentication: User (some parameters admin only)
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| tenant_id | integer | — | Admin only: filter by tenant. Ignored for tenant credentials, which only see their own tenant's data |
Set the tenant's default group
PUT
/api/v2/cache-policyAuthentication: User (some parameters admin only)
Request body application/json
| Field | Type | Required | Description |
|---|---|---|---|
| default_group_id | integer | Required | Platform default group; null = no group yet. |
Reset all sites to the default group
POST
/api/v2/cache-policy/reset-sitesAuthentication: User (some parameters admin only)
Cache policy object
| Field | Type | Required | Description |
|---|---|---|---|
| applied | integer | — | Number of sites updated. |
| default_group_id | integer | — | Platform default group; null = no group yet. |
| my_default_group_id | integer | — | Default group in effect for this tenant (the one it set, or the platform default if none). |
| my_default_group_set | boolean | — | Whether this tenant has set its own default group. |
| sites | object | — | Number of the tenant's sites by cache mode: group (follows a cache group) and custom (own rules). |