Skip to main content
PATCH
/
v2
/
aggregators
/
{aggregatorId}
Update Aggregator
curl --request PATCH \
  --url https://api.tusky.io/v2/aggregators/{aggregatorId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "subdomain": "<string>",
  "customDomain": "<string>",
  "restricted": true,
  "public": true,
  "cache": true,
  "fallbackToBackup": true,
  "analyticsEnabled": true
}
'
Update an aggregator’s configuration. Only included fields are updated.

​
Path Parameters

​
aggregatorId
string
required
The aggregator ID.

​
Request Body

​
subdomain
string
Subdomain for the aggregator. Must be unique, lowercase, 3–32 characters.
​
customDomain
string
Custom domain. Set to null to remove. Requires a CNAME record pointing to {subdomain}.mytusky.xyz.
​
restricted
boolean
When true, requests require authentication via Api-Key header. When false, content is served without authentication.
​
public
boolean
When true, the aggregator serves any content from the Walrus network. When false, it serves only your account’s content.
​
cache
boolean
Whether to enable Cloudflare edge caching. Caches content at 300+ global edge locations for low-latency delivery. Disable for content that changes frequently.
​
fallbackToBackup
boolean
Whether to fall back to the centralized backup store when Walrus is unavailable. Requires Backup to be enabled on the relevant environments.
​
analyticsEnabled
boolean
Whether to enable analytics tracking for requests.

​
Response

Returns the updated aggregator object.

​
Example

curl -X PATCH https://api.tusky.io/v2/aggregators/agg_default \
  -H "Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "public": true,
    "cache": true,
    "fallbackToBackup": true,
    "customDomain": "cdn.example.com"
  }'

​
Response

{
  "id": "agg_default",
  "url": "https://myapp.mytusky.xyz",
  "subdomain": "myapp",
  "customDomain": "cdn.example.com",
  "public": true,
  "cache": true,
  "fallbackToBackup": true,
  "analyticsEnabled": true,
  "updatedAt": "2026-03-06T14:00:00Z"
}
fallbackToBackup only works for environments with Backup enabled. If backup is not enabled, the flag is accepted but has no effect.