Sites sites
CDN-accelerated sites. Creating one needs at least a domain and an origin; admins can manage any tenant's sites.
Pick an endpoint to see its example call on the right.
Authentication
Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.
X-API-Key
Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).
Conventions
Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.
Times are RFC 3339 (UTC); amounts are in cents.
Writes return 200/201/204 on success; duplicates of a unique key return 409.
/api/v2/sitesList sites
Authentication: User (some parameters admin only)
Query parameters
| Field | Type | Description |
|---|---|---|
page | integer | Page number, starting from 1 |
page_size | integer | Items per page |
sort | string | Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id` |
tenant_id | integer | Admin only: filter by tenant (a malformed value returns 422). Ignored for tenant credentials, which only see their own tenant's data |
tenant_ids | string | Admin only: only these tenants, comma-separated positive integers, at most 200 after deduplication (more, or a malformed value, returns 422); a single ID works too. Filters only and does not switch the request scope; combined with tenant_id and other filters as an intersection. A tenant credential sending a non-empty value gets 403 |
ids | string | Only list these IDs: comma-separated positive integers, at most 200 after deduplication (same as the page_size limit; more, or a malformed value, returns 422); an empty value is the same as omitting it. Combined with other filters as an intersection; IDs you cannot see are silently left out. Pagination is unchanged: set page_size to at least the number of IDs to get them in one page |
domain | string | Filter by domain substring (case-insensitive); a.example.com also matches www.a.example.com. Use domains for exact matching. |
domains | string | Comma-separated domains; matches sites having any domain exactly equal to one of them (case-insensitive, no substring match). |
group_id | integer | Only list sites in this group. |
group_ids | string | Comma-separated group IDs (positive integers, at most 200 after deduplication); a site in any of them matches. May be combined with group_id (both must hold). |
app | string | Filter by the application identified by the checkup (exact match, e.g. wordpress); sites never checked do not match. |
enabled | boolean | Filter by enabled state. |
id | integer | Filter by exact site id (panel search box "Site ID"). |
name | string | Filter by name substring. |
origin | string | Filter by origin host substring (panel search box "Origin IP"). |
stop_code | integer | Filter by stop code; 0 = normal (panel search box "Site status"). |
upid | integer | Filter by user package. |
http_port | integer | Only list sites whose HTTP listen ports (config.http_ports) include this port; exact match (80 does not match 8080). |
https_port | integer | Only list sites whose HTTPS listen ports (config.https.ports) include this port; sites without HTTPS never match. |
https_enabled | boolean | true lists only sites with HTTPS enabled (config.https has listen ports); false lists only sites without HTTPS. |
upids | string | Filter by user packages: comma-separated positive integers, at most 200 after deduplication (more, or a malformed value, returns 422); a single ID works too; combined with other filters as an intersection |
package_id | integer | Filter by base package (the owning user package was bought from it). |
region_id | integer | Filter by region (the CNAME's primary line group belongs to it); owners without their own CNAME use their user package's shared one. |
node_group_id | integer | Filter by line group (the CNAME's primary or backup line group). |
cname_domain_id | integer | Filter by CNAME root domain. |
package_ids | string | Filter by base packages, same meaning as package_id: comma-separated positive integers, at most 200 after deduplication (more, or a malformed value, returns 422); a single ID works too; combined with other filters as an intersection |
region_ids | string | Filter by regions, same meaning as region_id: comma-separated positive integers, at most 200 after deduplication (more, or a malformed value, returns 422); a single ID works too; combined with other filters as an intersection |
node_group_ids | string | Filter by line groups, same meaning as node_group_id: comma-separated positive integers, at most 200 after deduplication (more, or a malformed value, returns 422); a single ID works too; combined with other filters as an intersection |
cname_domain_ids | string | Filter by CNAME root domains, same meaning as cname_domain_id: comma-separated positive integers, at most 200 after deduplication (more, or a malformed value, returns 422); a single ID works too; combined with other filters as an intersection |
cname_hostname | string | Filter by CNAME host label, exact match (case-insensitive, without the root domain). |
sync_state | string | Filter by config sync state: behind = some online node has not yet installed the config version containing its latest change; |
/api/v2/sitesCreate site
Authentication: User (some parameters admin only)
Query parameters
| Field | Type | Description |
|---|---|---|
tenant_id | integer | Owning tenant when an admin creates on behalf of a tenant (required); ignored for tenant callers, whose own account is always the owner. |
Request body application/json
| Field | Type | Description |
|---|---|---|
cname | CnameBinding | Access name (CNAME). Users point their domain to fqdn with a CNAME record; the platform generates its DNS records from the node group. null when there is no access name. |
config | object | Node config fields (top-level fields of schema/site.json, without id, uid, upid, domains, origins, enabled, stop_code and rulesets). |
domainsRequired | string[] | Domains served by the site. |
enabled | boolean | Whether enabled |
group_ids | integer[] | Ids of the site groups the site belongs to. |
name | string | Name |
originsRequired | SiteOrigin[] | Origin servers. |
stop_code | integer | 0 = normal; non-zero = every request is answered with this status code (set by admin or billing). |
upid | integer | User package id (may be empty before the package domain goes live; falls back to tenant_id in the snapshot when empty). |
/api/v2/sites/batchBatch update sites
Authentication: User (some parameters admin only)
Query parameters
| Field | Type | Description |
|---|---|---|
tenant_id | integer | Owning tenant when an admin creates on behalf of a tenant (required); ignored for tenant callers, whose own account is always the owner. |
Request body application/json
| Field | Type | Description |
|---|---|---|
actionRequired | string | Batch action: set_enabled, delete, set_groups, set_origins, update_config or create. |
config | object | Node config fields (top-level fields of schema/site.json, without id, uid, upid, domains, origins, enabled, stop_code and rulesets). |
enabled | boolean | Whether enabled |
group_ids | integer[] | Ids of the site groups the site belongs to. |
ids | integer[] | Ids of the sites to operate on (up to 100; required by every action except create). |
items | SiteWrite[] | Used by create: the sites to create (up to 100), each shaped like the POST /sites request body. |
origins | SiteOrigin[] | Origin servers. |
/api/v2/sites/batch-patchBatch edit site settings
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
changesRequired | object | Keyed by submit pointer (/config/..., /upid, /origins, /group_ids, /ip_list/black, /ip_list/white, /cache_group_id, /cache_overlay, /l2/enabled, /l2/origin_l2_only, /l2/l2_group_id, /l2/origin_max_conns, /l2/l2_pick, /config/https#ssl_mode, /config/https#cert_match); the value is the new value, null deletes the key. |
idsRequired | integer[] | Ids of the sites to operate on (up to 100; required by every action except create). |
/api/v2/sites/checkup-fix-batchBatch one-click fix for a checkup problem
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
batch | string | rec_type only - pass the batch returned by the first segment so all segments share one undo batch; omit to start a new batch. |
idsRequired | integer[] | Ids of the sites to operate on (up to 100; required by every action except create). |
keyRequired | string | Key of the checkup problem to fix, same meaning as the single-site fix. |
/api/v2/sites/checkup-fix-batchesList recent checkup fix batches
Authentication: User (some parameters admin only)
Query parameters
| Field | Type | Description |
|---|---|---|
tenant_id | integer | Admin only: filter by tenant (a malformed value returns 422). Ignored for tenant credentials, which only see their own tenant's data |
/api/v2/sites/config-summarySummarize configuration values across sites
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
fieldsRequired | string[] | Field pointers to summarize (as written in the batch-edit field table). |
idsRequired | integer[] | Ids of the sites to operate on (up to 100; required by every action except create). |
with_ids | boolean | When true, each value also returns ids (IDs of the sites with that value, ascending, at most 100000); only allowed with exactly one field, otherwise 400 invalid. |
/api/v2/sites/origin-alertsOrigin inconsistency alerts
Authentication: User (some parameters admin only)
Query parameters
| Field | Type | Description |
|---|---|---|
site_id | integer | Only this site. |
/api/v2/sites/protect-recommend/applyBatch apply the recommended protection settings
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
idsRequired | integer[] | Ids of the sites to operate on (up to 100; required by every action except create). |
observe_days | integer | Overrides the observe-first days of waf_mode in the table (0 blocks immediately); defaults to the table value. |
skip | string[] | Recommended items the user unticked and that must not be applied this time. |
typeRequired | string | Site type - corporate, shop, content, api, admin or download. |
/api/v2/sites/protect-recommend/previewPreview the impact of the recommended protection settings
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
idsRequired | integer[] | Ids of the sites to operate on (up to 100; required by every action except create). |
observe_days | integer | Overrides the observe-first days of waf_mode in the table (0 blocks immediately); defaults to the table value. |
skip | string[] | Recommended items the user unticked and that must not be applied this time. |
type | string | Site type - corporate, shop, content, api, admin or download. |
/api/v2/sites/protect-recommend/undoUndo a batch of recommended protection settings
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
batchRequired | string | rec_type only - pass the batch returned by the first segment so all segments share one undo batch; omit to start a new batch. |
idsRequired | integer[] | Ids of the sites to operate on (up to 100; required by every action except create). |
/api/v2/sites/region-checkPre-save check of a region limit
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
region_limitRequired | object | The region limit to check (same as Site.config.region_limit). |
/api/v2/sites/select-idsGet all site IDs matching a filter
Authentication: User (some parameters admin only)
Query parameters
| Field | Type | Description |
|---|---|---|
tenant_id | integer | Admin only: filter by tenant (a malformed value returns 422). Ignored for tenant credentials, which only see their own tenant's data |
Request body application/json
| Field | Type | Description |
|---|---|---|
app | string | Filter by the application identified by the checkup (exact match). |
cname_domain_id | integer | Filter by CNAME root domain. |
cname_domain_ids | integer[] | Filter by CNAME root domains, same meaning as cname_domain_id (at most 200 after deduplication); matches any of them; combined with other filters as an intersection. |
cname_hostname | string | Filter by CNAME host label, exact match (case-insensitive, without the root domain). |
domain | string | Filter by domain substring (case-insensitive). |
domains | string[] | Domains served by the site. |
enabled | boolean | Whether enabled |
group_id | integer | Only sites in this group. |
group_ids | integer[] | Ids of the site groups the site belongs to. |
http_port | integer | Only sites whose HTTP listen ports include this port; exact match (80 does not match 8080). |
https_enabled | boolean | true selects only sites with HTTPS enabled, false only those without. |
https_port | integer | Only sites whose HTTPS listen ports include this port; sites without HTTPS never match. |
id | integer | Record ID |
ids | integer[] | Ids of the sites to operate on (up to 100; required by every action except create). |
name | string | Name |
node_group_id | integer | Filter by line group (the CNAME's primary or backup line group). |
node_group_ids | integer[] | Filter by line groups, same meaning as node_group_id (at most 200 after deduplication); matches any of them; combined with other filters as an intersection. |
origin | string | Filter by origin host substring. |
package_id | integer | Filter by base package (the owning user package was bought from it). |
package_ids | integer[] | Filter by base packages, same meaning as package_id (at most 200 after deduplication); matches any of them; combined with other filters as an intersection. |
region_id | integer | Filter by region (the CNAME's primary line group belongs to it); owners without their own CNAME use their user package's shared one. |
region_ids | integer[] | Filter by regions, same meaning as region_id (at most 200 after deduplication); matches any of them; combined with other filters as an intersection. |
stop_code | integer | 0 = normal; non-zero = every request is answered with this status code (set by admin or billing). |
sync_state | string | Filter by config sync state: behind = some online node has not yet installed the config version containing its latest change; synced = all online nodes have it. |
tenant_ids | integer[] | Admin only: only sites of these tenants (at most 200 after deduplication); filters only and does not switch the request scope; intersected with the tenant_id query parameter. A tenant credential sending a non-empty value gets 403. |
upid | integer | User package id (may be empty before the package domain goes live; falls back to tenant_id in the snapshot when empty). |
upids | integer[] | Only sites under any of these user packages; may be combined with upid (both must hold). |
with_domain | boolean | When true, the response also returns items (each site's ID and first domain) so batch editing can list the selected sites. |
/api/v2/sites/{id}Get site
Authentication: User (some parameters admin only)
/api/v2/sites/{id}Update site
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
cname | CnameBinding | Access name (CNAME). Users point their domain to fqdn with a CNAME record; the platform generates its DNS records from the node group. null when there is no access name. |
config | object | Node config fields (top-level fields of schema/site.json, without id, uid, upid, domains, origins, enabled, stop_code and rulesets). |
domains | string[] | Domains served by the site. |
enabled | boolean | Whether enabled |
expected_updated_at | string | Optimistic lock (used on update) - the updated_at of the resource as the caller read it. If it differs from the stored one, 409 stale_version is returned and nothing is saved; omit to skip the check. |
group_ids | integer[] | Ids of the site groups the site belongs to. |
name | string | Name |
origins | SiteOrigin[] | Origin servers. |
stop_code | integer | 0 = normal; non-zero = every request is answered with this status code (set by admin or billing). |
upid | integer | User package id (may be empty before the package domain goes live; falls back to tenant_id in the snapshot when empty). |
/api/v2/sites/{id}Delete site
Authentication: User (some parameters admin only)
/api/v2/sites/{id}/checkup-fixOne-click fix for a checkup problem
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
keyRequired | string | Key of the checkup problem to fix, same meaning as the single-site fix. |
/api/v2/sites/{id}/dns-checkCheck whether the site domains point to this platform
Authentication: User (some parameters admin only)
/api/v2/sites/{id}/healthSite origin health status
Authentication: User (some parameters admin only)
/api/v2/sites/{id}/l2Get site tiered origin
Authentication: User (some parameters admin only)
/api/v2/sites/{id}/l2Update site tiered origin
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
enabled | boolean | Whether enabled |
l2_group_id | integer | L2 group used; null for region default. |
l2_pick | string | How L2 is picked for this site; null to follow the defaults. |
origin_l2_only | boolean | Origin allows only L2: dynamic requests also go via L2, borrowing other regions when needed. |
origin_max_conns | integer | Max origin concurrency per node; 0 for unlimited. Excess requests queue instead of failing with 503. |
/api/v2/sites/{id}/l2-egress-ipsOrigin allowlist
Authentication: User (some parameters admin only)
Query parameters
| Field | Type | Description |
|---|---|---|
fmt | string | Format of text: ip one per line, nginx allow lines, or iptables rules; defaults to ip. |
/api/v2/sites/{id}/l2-statsSite tiered origin statistics
Authentication: User (some parameters admin only)
Query parameters
| Field | Type | Description |
|---|---|---|
startRequired | string | Start time (inclusive), RFC 3339 |
endRequired | string | End time (exclusive), RFC 3339 |
/api/v2/sites/{id}/site-typeSet the site type
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
typeRequired | string | Site type - corporate, shop, content, api, admin or download. |
/api/v2/sites/{id}/speedSite acceleration statistics
Authentication: User (some parameters admin only)
Query parameters
| Field | Type | Description |
|---|---|---|
range | string | Statistics window, default 24h. |
country | string | Only requests from this country or region (ISO 3166-1 alpha-2, same value as the access log country). |
isp | string | Only requests from this ISP (same value as the access log isp). |
http_ver | string | Only requests over this HTTP version. |
/api/v2/sites/{id}/upload-scan/exceptionsList a site's upload scan exceptions
Authentication: User (some parameters admin only)
/api/v2/sites/{id}/upload-scan/false-positiveMark a site's upload scan hit as a false positive
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
path | string | Path prefix (starting with /); defaults to /. |
sha256 | string | sha256 of the hit file (lowercase hex); a tenant's value must appear in the site's upload hit events; if given, intelligence sharing is on and sig is not empty, a false-positive intelligence item is queued in the same transaction. |
sig | string | Signature name of the false positive (the rule name in the event); empty = the whole path is not scanned (path is then required). |
/api/v2/sites/{id}/upload-scan/false-positiveRevoke a site's upload scan false-positive mark
Authentication: User (some parameters admin only)
Query parameters
| Field | Type | Description |
|---|---|---|
pathRequired | string | Path prefix of the exception. |
sig | string | Signature name of the exception; omitted or empty = a whole-path exception. |
/api/v2/sites/{id}/url-guard/activeList a site's URL protections in effect
Authentication: User (some parameters admin only)
/api/v2/sites/{id}/url-guard/revokeManually revoke a site's URL protections in effect
Authentication: User (some parameters admin only)
Request body application/json
| Field | Type | Description |
|---|---|---|
path | string | Path prefix (starting with /); defaults to /. |
Sites object
| Field | Type | Description |
|---|---|---|
actionRequired | string | Batch action: set_enabled, delete, set_groups, set_origins, update_config or create. |
added_at | string | When the entry was added; early manual entries have none. |
affected | integer | Number of affected records |
app | string | Filter by the application identified by the checkup (exact match). |
as_of | string | Data as of, the latest moment both usage and the access log cover within the window (the earlier of the two, or the only one with data), never after end; null when the window has no data. |
basis | string | Source of totals and points, usage for live usage (no filter), log for the access log scaled by sample weight (a filter is set). |
batch | string | rec_type only - pass the batch returned by the first segment so all segments share one undo batch; omit to start a new batch. |
capacity_warnings | SiteCapacityWarning[] | Only in the responses of creating a site (POST /sites) and moving it to another line group (PUT /sites/{id}), when a node of the target line group has reached its memory capacity limit; a warning only, never blocks. Omitted when no node is over the limit. |
changesRequired | object | Keyed by submit pointer (/config/..., /upid, /origins, /group_ids, /ip_list/black, /ip_list/white, /cache_group_id, /cache_overlay, /l2/enabled, /l2/origin_l2_only, /l2/l2_group_id, /l2/origin_max_conns, /l2/l2_pick, /config/https#ssl_mode, /config/https#cert_match); the value is the new value, null deletes the key. |
checked_at | string | Time the details were requested from the nodes. |
cname | CnameBinding | Access name (CNAME). Users point their domain to fqdn with a CNAME record; the platform generates its DNS records from the node group. null when there is no access name. |
cname_domain_id | integer | Filter by CNAME root domain. |
cname_domain_ids | integer[] | Filter by CNAME root domains, same meaning as cname_domain_id (at most 200 after deduplication); matches any of them; combined with other filters as an intersection. |
cname_hostname | string | Filter by CNAME host label, exact match (case-insensitive, without the root domain). |
conditions | object | Keyed by parent switch pointer (/config form) or /config/region_limit/mode; parent switches return on / off, the region limit mode returns block / allow. |
config | object | Node config fields (top-level fields of schema/site.json, without id, uid, upid, domains, origins, enabled, stop_code and rulesets). |
country | string | Country/region code, omitted if unknown. |
created_at | string | Created at |
default_pick | string | The current default method (applies when l2_pick is null). |
domain | string | Filter by domain substring (case-insensitive). |
domains | string[] | Domains served by the site. |
edge_origin_requests | integer | Edge origin requests (hit rate denominator). |
enabled | boolean | Whether enabled |
end | string | Window end (exclusive), the current time rounded down to 5 minutes. |
expected_updated_at | string | Optimistic lock (used on update) - the updated_at of the resource as the caller read it. If it differs from the stored one, 409 stale_version is returned and nothing is saved; omit to skip the check. |
facets | SiteSpeedFacets | Values with requests in the window for each filter dimension, by requests descending; each dimension applies the other dimensions' filters but not its own; unidentified empty values are omitted. |
fieldsRequired | string[] | Field pointers to summarize (as written in the batch-edit field table). |
found | boolean | The IP was found in the database (otherwise judged as an unidentified visitor). |
group_id | integer | Only sites in this group. |
group_ids | integer[] | Ids of the site groups the site belongs to. |
group_options | L2SiteRefGroup[] | Custom L2 groups available. |
h3_off_nodes | SiteSpeedH3Off | Nodes in the node group the site currently resolves to that the master judged UDP 443 unreachable (not advertising HTTP/3); omitted when HTTP/3 probing is off, the site has no CNAME binding or all nodes are reachable. |
hit_rate | number | Hit rate 0-1; 0 when there were no origin requests. |
http_port | integer | Only sites whose HTTP listen ports include this port; exact match (80 does not match 8080). |
https_enabled | boolean | true selects only sites with HTTPS enabled, false only those without. |
https_port | integer | Only sites whose HTTPS listen ports include this port; sites without HTTPS never match. |
id | integer | Record ID |
ids | integer[] | Ids of the sites to operate on (up to 100; required by every action except create). |
ip | string | The caller's IP. |
isp | string | ISP code, omitted if unknown. |
items | SiteWrite[] | Used by create: the sites to create (up to 100), each shaped like the POST /sites request body. |
keyRequired | string | Key of the checkup problem to fix, same meaning as the single-site fix. |
l2_group_id | integer | L2 group used; null for region default. |
l2_hit_requests | integer | Origin requests served by L2 (hit rate numerator). |
l2_pick | string | How L2 is picked for this site; null to follow the defaults. |
log | SiteSpeedLog | Protocol split, origin time percentiles, sampled cache-miss URLs and edge response times from the raw access log (weighted by sample weight), same window as totals. |
log_keep_days | integer | Raw access log retention in days (reports.access_log_days); when the window is longer, log only covers what is still kept. |
missing | string[] | Selected fields the current database has no data for (those selections never match). |
name | string | Name |
node_group_id | integer | Filter by line group (the CNAME's primary or backup line group). |
node_group_ids | integer[] | Filter by line groups, same meaning as node_group_id (at most 200 after deduplication); matches any of them; combined with other filters as an intersection. |
node_issues | NodeIssue[] | Ports or reasons for which the site is not fully in effect on online nodes (in the list and the detail); omitted when everything is in effect. |
nodes | SiteHealthNode[] | Details from each active node, ordered by node id. |
observe_days | integer | Overrides the observe-first days of waf_mode in the table (0 blocks immediately); defaults to the table value. |
origin | string | Filter by origin host substring. |
origin_changes | SiteOriginChange[] | set_origins only: old to new origins of each site, in ascending id order. |
origin_l2_only | boolean | Origin allows only L2: dynamic requests also go via L2, borrowing other regions when needed. |
origin_max_conns | integer | Max origin concurrency per node; 0 for unlimited. Excess requests queue instead of failing with 503. |
origin_requests | integer | Requests that reached the origin. |
origin_requests_est | integer | Estimate without tiering (= edge origin requests). |
origins | SiteOrigin[] | Origin servers. |
package_id | integer | Filter by base package (the owning user package was bought from it). |
package_ids | integer[] | Filter by base packages, same meaning as package_id (at most 200 after deduplication); matches any of them; combined with other filters as an intersection. |
path | string | Path prefix (starting with /); defaults to /. |
pointed | boolean | All domains except wildcards point to this platform. |
points | SiteSpeedPoint[] | Per-bucket details (only buckets with traffic are listed). |
prov | string | Province code, omitted if unknown. |
publish_seq | integer | Only in the responses of creating and updating a site: the sequence number of this write (same as the Publish-Seq response header); pass it to GET /config-publish/applied?seq= to check whether it has reached the nodes. |
range | string | Statistics window (1h, 24h or 7d). |
rec_ver | integer | Version of the recommendation table used. |
region_id | integer | Filter by region (the CNAME's primary line group belongs to it); owners without their own CNAME use their user package's shared one. |
region_ids | integer[] | Filter by regions, same meaning as region_id (at most 200 after deduplication); matches any of them; combined with other filters as an intersection. |
region_limitRequired | object | The region limit to check (same as Site.config.region_limit). |
region_names | string[] | Names of the regions with a serving L2, ordered by region ID; as many as regions. |
regions | integer | Regions with a serving L2. |
results | SiteBatchPatchItem[] | Per-site results in request order (a repeated site appears once). |
revoked | string[] | Revoked paths. |
revoking_until | string | When the site's tiered origin stops working, the earliest of license revocation, license fallback window end and the owning tenant's plan window end; present only when state is revoking and the time is known (omitted e.g. when merely frozen). |
saved_bytes | integer | Origin traffic saved (bytes served from L2 cache). |
sha256 | string | sha256 of the hit file (lowercase hex); a tenant's value must appear in the site's upload hit events; if given, intelligence sharing is on and sig is not empty, a false-positive intelligence item is queued in the same transaction. |
sig | string | Signature name of the false positive (the rule name in the event); empty = the whole path is not scanned (path is then required). |
site_id | integer | Site id; 0 = all sites. |
skip | string[] | Recommended items the user unticked and that must not be applied this time. |
source | string | user chosen manually; auto detected from traffic. |
start | string | Window start. |
state | string | Effective state: on, off, not_open, paused, no_l2, or revoking. |
status | string | disabled = active health checks are off; unknown = no node returned details; healthy = all origins up on the nodes that answered; unhealthy = some origin is removed. |
stop_code | integer | 0 = normal; non-zero = every request is answered with this status code (set by admin or billing). |
sync_state | string | Filter by config sync state: behind = some online node has not yet installed the config version containing its latest change; synced = all online nodes have it. |
tenant_id | integer | Owner tenant (user) ID |
tenant_ids | integer[] | Admin only: only sites of these tenants (at most 200 after deduplication); filters only and does not switch the request scope; intersected with the tenant_id query parameter. A tenant credential sending a non-empty value gets 403. |
text | string | Text in the requested format, ready to paste on the origin. |
totals | SiteSpeedTotals | Totals over the whole window. |
typeRequired | string | Site type - corporate, shop, content, api, admin or download. |
updated_at | string | Updated at |
upid | integer | User package id (may be empty before the package domain goes live; falls back to tenant_id in the snapshot when empty). |
upids | integer[] | Only sites under any of these user packages; may be combined with upid (both must hold). |
verdict | string | Result for the caller visiting the home page: pass, block (blocked) or log (logged only). |
waf_gate | SiteWafGate | Only in the site detail (GET /sites/{id}): the WAF Enhanced status of the site's owner and why it is not in effect. owner, packages and expired_at are in administrator responses only; tenants get gate and reason only. List rows carry waf_gate_reason alone. |
waf_gate_reason | WafGateReason | Why WAF Enhanced (waf_enhanced) is not in effect; absent when gate is full or readonly. package = the platform is licensed but the owner has no unexpired package that includes WAF Enhanced; license = the platform has not enabled it (never licensed, revoked by the provider, or the license was disabled); expired = the platform license has expired and its read-only buffer period (License.readonly_days, default 7 days) has passed, so it fell back to basic. |
with_domain | boolean | When true, the response also returns items (each site's ID and first domain) so batch editing can list the selected sites. |
with_ids | boolean | When true, each value also returns ids (IDs of the sites with that value, ascending, at most 100000); only allowed with exactly one field, otherwise 400 invalid. |
Responses and errors
Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.
{
"id": 1,
"name": "example"
}{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"code": "validation_failed",
"detail": "Invalid request parameters",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name is required"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}