Skip to main content
GET
/
v2
/
aggregators
/
{aggregatorId}
Get Aggregator
curl --request GET \
  --url https://api.tusky.io/v2/aggregators/{aggregatorId}
{
  "id": "<string>",
  "url": "<string>",
  "subdomain": "<string>",
  "customDomain": "<string>",
  "restricted": true,
  "public": true,
  "cache": true,
  "fallbackToBackup": true,
  "analyticsEnabled": true,
  "createdAt": "<string>"
}
Retrieve an aggregator by ID.

​
Path Parameters

​
aggregatorId
string
required
The aggregator ID. Use default for the account’s primary aggregator.

​
Response

​
id
string
Unique aggregator identifier.
​
url
string
The full URL of the aggregator (e.g., https://myapp.mytusky.xyz).
​
subdomain
string
The subdomain (e.g., myapp).
​
customDomain
string
Custom domain, or null if not configured.
​
restricted
boolean
Whether authentication is required. When true, requests must include an Api-Key header.
​
public
boolean
When true, serves any content from the Walrus network. When false, serves only your account’s content.
​
cache
boolean
Whether Cloudflare edge caching is enabled. When true, content is cached at 300+ edge locations for low-latency delivery.
​
fallbackToBackup
boolean
Whether the aggregator falls back to the centralized backup store when the Walrus network is unavailable.
​
analyticsEnabled
boolean
Whether analytics tracking is enabled.
​
createdAt
string
ISO 8601 creation timestamp.

​
Example

curl https://api.tusky.io/v2/aggregators/default \
  -H "Api-Key: YOUR_API_KEY"

​
Response

{
  "id": "agg_default",
  "url": "https://myapp.mytusky.xyz",
  "subdomain": "myapp",
  "customDomain": null,
  "restricted": false,
  "public": false,
  "cache": true,
  "fallbackToBackup": false,
  "analyticsEnabled": true,
  "createdAt": "2026-01-15T10:00:00Z"
}