Version 2.4.7.20261116085428 · latest

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.

SitesAuthentication: User (some parameters admin only)30 endpoints

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.

GET/api/v2/sitesList sites

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
pageinteger Page number, starting from 1
Default 1
page_sizeinteger Items per page
Default 20
sortstring Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`
tenant_idinteger Admin only: filter by tenant (a malformed value returns 422). Ignored for tenant credentials, which only see their own tenant's data
tenant_idsstring 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
idsstring 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
domainstring Filter by domain substring (case-insensitive); a.example.com also matches www.a.example.com. Use domains for exact matching.
domainsstring Comma-separated domains; matches sites having any domain exactly equal to one of them (case-insensitive, no substring match).
group_idinteger Only list sites in this group.
group_idsstring 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).
appstring Filter by the application identified by the checkup (exact match, e.g. wordpress); sites never checked do not match.
enabledboolean Filter by enabled state.
idinteger Filter by exact site id (panel search box "Site ID").
namestring Filter by name substring.
originstring Filter by origin host substring (panel search box "Origin IP").
stop_codeinteger Filter by stop code; 0 = normal (panel search box "Site status").
upidinteger Filter by user package.
http_portinteger Only list sites whose HTTP listen ports (config.http_ports) include this port; exact match (80 does not match 8080).
https_portinteger Only list sites whose HTTPS listen ports (config.https.ports) include this port; sites without HTTPS never match.
https_enabledboolean true lists only sites with HTTPS enabled (config.https has listen ports); false lists only sites without HTTPS.
upidsstring 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_idinteger Filter by base package (the owning user package was bought from it).
region_idinteger 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_idinteger Filter by line group (the CNAME's primary or backup line group).
cname_domain_idinteger Filter by CNAME root domain.
package_idsstring 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_idsstring 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_idsstring 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_idsstring 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_hostnamestring Filter by CNAME host label, exact match (case-insensitive, without the root domain).
sync_statestring Filter by config sync state: behind = some online node has not yet installed the config version containing its latest change;
Values ["behind","synced"]
POST/api/v2/sitesCreate site

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
tenant_idinteger 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

FieldTypeDescription
cnameCnameBinding 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.
configobject Node config fields (top-level fields of schema/site.json, without id, uid, upid, domains, origins, enabled, stop_code and rulesets).
domainsRequiredstring[] Domains served by the site.
enabledboolean Whether enabled
group_idsinteger[] Ids of the site groups the site belongs to.
namestring Name
originsRequiredSiteOrigin[] Origin servers.
stop_codeinteger 0 = normal; non-zero = every request is answered with this status code (set by admin or billing).
upidinteger User package id (may be empty before the package domain goes live; falls back to tenant_id in the snapshot when empty).
POST/api/v2/sites/batchBatch update sites

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
tenant_idinteger 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

FieldTypeDescription
actionRequiredstring Batch action: set_enabled, delete, set_groups, set_origins, update_config or create.
Values ["set_enabled","delete","set_groups","set_origins","update_config","create"]
configobject Node config fields (top-level fields of schema/site.json, without id, uid, upid, domains, origins, enabled, stop_code and rulesets).
enabledboolean Whether enabled
group_idsinteger[] Ids of the site groups the site belongs to.
idsinteger[] Ids of the sites to operate on (up to 100; required by every action except create).
itemsSiteWrite[] Used by create: the sites to create (up to 100), each shaped like the POST /sites request body.
originsSiteOrigin[] Origin servers.
POST/api/v2/sites/batch-patchBatch edit site settings

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
changesRequiredobject 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.
idsRequiredinteger[] Ids of the sites to operate on (up to 100; required by every action except create).
POST/api/v2/sites/checkup-fix-batchBatch one-click fix for a checkup problem

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
batchstring rec_type only - pass the batch returned by the first segment so all segments share one undo batch; omit to start a new batch.
idsRequiredinteger[] Ids of the sites to operate on (up to 100; required by every action except create).
keyRequiredstring Key of the checkup problem to fix, same meaning as the single-site fix.
Values ["no_https","tls_old","sec_headers","waf_block","cc_mid","rec_type","waf_level","origin_https","cert_expiring","login_limit","upload_unscanned","upload_sig","leak_phone","sensitive_files"]
GET/api/v2/sites/checkup-fix-batchesList recent checkup fix batches

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
tenant_idinteger Admin only: filter by tenant (a malformed value returns 422). Ignored for tenant credentials, which only see their own tenant's data
POST/api/v2/sites/config-summarySummarize configuration values across sites

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
fieldsRequiredstring[] Field pointers to summarize (as written in the batch-edit field table).
idsRequiredinteger[] Ids of the sites to operate on (up to 100; required by every action except create).
with_idsboolean 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.
GET/api/v2/sites/origin-alertsOrigin inconsistency alerts

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
site_idinteger Only this site.
POST/api/v2/sites/protect-recommend/applyBatch apply the recommended protection settings

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
idsRequiredinteger[] Ids of the sites to operate on (up to 100; required by every action except create).
observe_daysinteger Overrides the observe-first days of waf_mode in the table (0 blocks immediately); defaults to the table value.
skipstring[] Recommended items the user unticked and that must not be applied this time.
typeRequiredstring Site type - corporate, shop, content, api, admin or download.
Values ["corporate","shop","content","api","admin","download"]
POST/api/v2/sites/protect-recommend/previewPreview the impact of the recommended protection settings

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
idsRequiredinteger[] Ids of the sites to operate on (up to 100; required by every action except create).
observe_daysinteger Overrides the observe-first days of waf_mode in the table (0 blocks immediately); defaults to the table value.
skipstring[] Recommended items the user unticked and that must not be applied this time.
typestring Site type - corporate, shop, content, api, admin or download.
Values ["corporate","shop","content","api","admin","download"]
POST/api/v2/sites/protect-recommend/undoUndo a batch of recommended protection settings

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
batchRequiredstring rec_type only - pass the batch returned by the first segment so all segments share one undo batch; omit to start a new batch.
idsRequiredinteger[] Ids of the sites to operate on (up to 100; required by every action except create).
POST/api/v2/sites/region-checkPre-save check of a region limit

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
region_limitRequiredobject The region limit to check (same as Site.config.region_limit).
POST/api/v2/sites/select-idsGet all site IDs matching a filter

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
tenant_idinteger 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

FieldTypeDescription
appstring Filter by the application identified by the checkup (exact match).
cname_domain_idinteger Filter by CNAME root domain.
cname_domain_idsinteger[] 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_hostnamestring Filter by CNAME host label, exact match (case-insensitive, without the root domain).
domainstring Filter by domain substring (case-insensitive).
domainsstring[] Domains served by the site.
enabledboolean Whether enabled
group_idinteger Only sites in this group.
group_idsinteger[] Ids of the site groups the site belongs to.
http_portinteger Only sites whose HTTP listen ports include this port; exact match (80 does not match 8080).
https_enabledboolean true selects only sites with HTTPS enabled, false only those without.
https_portinteger Only sites whose HTTPS listen ports include this port; sites without HTTPS never match.
idinteger Record ID
idsinteger[] Ids of the sites to operate on (up to 100; required by every action except create).
namestring Name
node_group_idinteger Filter by line group (the CNAME's primary or backup line group).
node_group_idsinteger[] 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.
originstring Filter by origin host substring.
package_idinteger Filter by base package (the owning user package was bought from it).
package_idsinteger[] 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_idinteger 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_idsinteger[] 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_codeinteger 0 = normal; non-zero = every request is answered with this status code (set by admin or billing).
sync_statestring 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.
Values ["behind","synced"]
tenant_idsinteger[] 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.
upidinteger User package id (may be empty before the package domain goes live; falls back to tenant_id in the snapshot when empty).
upidsinteger[] Only sites under any of these user packages; may be combined with upid (both must hold).
with_domainboolean When true, the response also returns items (each site's ID and first domain) so batch editing can list the selected sites.
GET/api/v2/sites/{id}Get site

Authentication: User (some parameters admin only)

PUT/api/v2/sites/{id}Update site

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
cnameCnameBinding 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.
configobject Node config fields (top-level fields of schema/site.json, without id, uid, upid, domains, origins, enabled, stop_code and rulesets).
domainsstring[] Domains served by the site.
enabledboolean Whether enabled
expected_updated_atstring 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_idsinteger[] Ids of the site groups the site belongs to.
namestring Name
originsSiteOrigin[] Origin servers.
stop_codeinteger 0 = normal; non-zero = every request is answered with this status code (set by admin or billing).
upidinteger User package id (may be empty before the package domain goes live; falls back to tenant_id in the snapshot when empty).
DELETE/api/v2/sites/{id}Delete site

Authentication: User (some parameters admin only)

POST/api/v2/sites/{id}/checkup-fixOne-click fix for a checkup problem

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
keyRequiredstring Key of the checkup problem to fix, same meaning as the single-site fix.
Values ["no_https","tls_old","sec_headers","waf_block","cc_mid","rec_type","waf_level","origin_https","cert_expiring","login_limit","upload_unscanned","upload_sig","leak_phone","sensitive_files"]
GET/api/v2/sites/{id}/healthSite origin health status

Authentication: User (some parameters admin only)

GET/api/v2/sites/{id}/l2Get site tiered origin

Authentication: User (some parameters admin only)

PATCH/api/v2/sites/{id}/l2Update site tiered origin

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
enabledboolean Whether enabled
l2_group_idinteger L2 group used; null for region default.
l2_pickstring How L2 is picked for this site; null to follow the defaults.
Values ["region","near"]
origin_l2_onlyboolean Origin allows only L2: dynamic requests also go via L2, borrowing other regions when needed.
origin_max_connsinteger Max origin concurrency per node; 0 for unlimited. Excess requests queue instead of failing with 503.
GET/api/v2/sites/{id}/l2-egress-ipsOrigin allowlist

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
fmtstring Format of text: ip one per line, nginx allow lines, or iptables rules; defaults to ip.
Values ["ip","nginx","iptables"]Default "ip"
GET/api/v2/sites/{id}/l2-statsSite tiered origin statistics

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
startRequiredstring Start time (inclusive), RFC 3339
endRequiredstring End time (exclusive), RFC 3339
PUT/api/v2/sites/{id}/site-typeSet the site type

Authentication: User (some parameters admin only)

Request body application/json

FieldTypeDescription
typeRequiredstring Site type - corporate, shop, content, api, admin or download.
Values ["corporate","shop","content","api","admin","download"]
GET/api/v2/sites/{id}/speedSite acceleration statistics

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
rangestring Statistics window, default 24h.
Values ["1h","24h","7d"]Default "24h"
countrystring Only requests from this country or region (ISO 3166-1 alpha-2, same value as the access log country).
ispstring Only requests from this ISP (same value as the access log isp).
http_verstring Only requests over this HTTP version.
Values ["1.0","1.1","2","3"]
POST/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

FieldTypeDescription
pathstring Path prefix (starting with /); defaults to /.
sha256string 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.
sigstring Signature name of the false positive (the rule name in the event); empty = the whole path is not scanned (path is then required).
DELETE/api/v2/sites/{id}/upload-scan/false-positiveRevoke a site's upload scan false-positive mark

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
pathRequiredstring Path prefix of the exception.
sigstring Signature name of the exception; omitted or empty = a whole-path exception.
GET/api/v2/sites/{id}/url-guard/activeList a site's URL protections in effect

Authentication: User (some parameters admin only)

POST/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

FieldTypeDescription
pathstring Path prefix (starting with /); defaults to /.

Sites object

FieldTypeDescription
actionRequiredstring Batch action: set_enabled, delete, set_groups, set_origins, update_config or create.
Values ["set_enabled","delete","set_groups","set_origins","update_config","create"]
added_atstring When the entry was added; early manual entries have none.
affectedinteger Number of affected records
appstring Filter by the application identified by the checkup (exact match).
as_ofstring 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.
basisstring Source of totals and points, usage for live usage (no filter), log for the access log scaled by sample weight (a filter is set).
Values ["usage","log"]
batchstring 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_warningsSiteCapacityWarning[] 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.
read-only
changesRequiredobject 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_atstring Time the details were requested from the nodes.
cnameCnameBinding 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_idinteger Filter by CNAME root domain.
cname_domain_idsinteger[] 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_hostnamestring Filter by CNAME host label, exact match (case-insensitive, without the root domain).
conditionsobject Keyed by parent switch pointer (/config form) or /config/region_limit/mode; parent switches return on / off, the region limit mode returns block / allow.
configobject Node config fields (top-level fields of schema/site.json, without id, uid, upid, domains, origins, enabled, stop_code and rulesets).
countrystring Country/region code, omitted if unknown.
created_atstring Created at
read-only
default_pickstring The current default method (applies when l2_pick is null).
Values ["region","near"]
domainstring Filter by domain substring (case-insensitive).
domainsstring[] Domains served by the site.
edge_origin_requestsinteger Edge origin requests (hit rate denominator).
enabledboolean Whether enabled
endstring Window end (exclusive), the current time rounded down to 5 minutes.
expected_updated_atstring 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.
facetsSiteSpeedFacets 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.
fieldsRequiredstring[] Field pointers to summarize (as written in the batch-edit field table).
foundboolean The IP was found in the database (otherwise judged as an unidentified visitor).
group_idinteger Only sites in this group.
group_idsinteger[] Ids of the site groups the site belongs to.
group_optionsL2SiteRefGroup[] Custom L2 groups available.
h3_off_nodesSiteSpeedH3Off 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_ratenumber Hit rate 0-1; 0 when there were no origin requests.
http_portinteger Only sites whose HTTP listen ports include this port; exact match (80 does not match 8080).
https_enabledboolean true selects only sites with HTTPS enabled, false only those without.
https_portinteger Only sites whose HTTPS listen ports include this port; sites without HTTPS never match.
idinteger Record ID
read-only
idsinteger[] Ids of the sites to operate on (up to 100; required by every action except create).
ipstring The caller's IP.
ispstring ISP code, omitted if unknown.
itemsSiteWrite[] Used by create: the sites to create (up to 100), each shaped like the POST /sites request body.
keyRequiredstring Key of the checkup problem to fix, same meaning as the single-site fix.
Values ["no_https","tls_old","sec_headers","waf_block","cc_mid","rec_type","waf_level","origin_https","cert_expiring","login_limit","upload_unscanned","upload_sig","leak_phone","sensitive_files"]
l2_group_idinteger L2 group used; null for region default.
l2_hit_requestsinteger Origin requests served by L2 (hit rate numerator).
l2_pickstring How L2 is picked for this site; null to follow the defaults.
Values ["region","near"]
logSiteSpeedLog 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_daysinteger Raw access log retention in days (reports.access_log_days); when the window is longer, log only covers what is still kept.
missingstring[] Selected fields the current database has no data for (those selections never match).
namestring Name
node_group_idinteger Filter by line group (the CNAME's primary or backup line group).
node_group_idsinteger[] 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_issuesNodeIssue[] 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.
read-only
nodesSiteHealthNode[] Details from each active node, ordered by node id.
observe_daysinteger Overrides the observe-first days of waf_mode in the table (0 blocks immediately); defaults to the table value.
originstring Filter by origin host substring.
origin_changesSiteOriginChange[] set_origins only: old to new origins of each site, in ascending id order.
origin_l2_onlyboolean Origin allows only L2: dynamic requests also go via L2, borrowing other regions when needed.
origin_max_connsinteger Max origin concurrency per node; 0 for unlimited. Excess requests queue instead of failing with 503.
origin_requestsinteger Requests that reached the origin.
origin_requests_estinteger Estimate without tiering (= edge origin requests).
originsSiteOrigin[] Origin servers.
package_idinteger Filter by base package (the owning user package was bought from it).
package_idsinteger[] 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.
pathstring Path prefix (starting with /); defaults to /.
pointedboolean All domains except wildcards point to this platform.
pointsSiteSpeedPoint[] Per-bucket details (only buckets with traffic are listed).
provstring Province code, omitted if unknown.
publish_seqinteger 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.
read-only
rangestring Statistics window (1h, 24h or 7d).
rec_verinteger Version of the recommendation table used.
region_idinteger 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_idsinteger[] 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_limitRequiredobject The region limit to check (same as Site.config.region_limit).
region_namesstring[] Names of the regions with a serving L2, ordered by region ID; as many as regions.
regionsinteger Regions with a serving L2.
resultsSiteBatchPatchItem[] Per-site results in request order (a repeated site appears once).
revokedstring[] Revoked paths.
revoking_untilstring 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_bytesinteger Origin traffic saved (bytes served from L2 cache).
sha256string 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.
sigstring Signature name of the false positive (the rule name in the event); empty = the whole path is not scanned (path is then required).
site_idinteger Site id; 0 = all sites.
skipstring[] Recommended items the user unticked and that must not be applied this time.
sourcestring user chosen manually; auto detected from traffic.
Values ["user","auto"]
startstring Window start.
statestring Effective state: on, off, not_open, paused, no_l2, or revoking.
Values ["on","off","not_open","paused","no_l2","revoking"]
statusstring 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_codeinteger 0 = normal; non-zero = every request is answered with this status code (set by admin or billing).
sync_statestring 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.
Values ["behind","synced"]
tenant_idinteger Owner tenant (user) ID
read-only
tenant_idsinteger[] 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.
textstring Text in the requested format, ready to paste on the origin.
totalsSiteSpeedTotals Totals over the whole window.
typeRequiredstring Site type - corporate, shop, content, api, admin or download.
Values ["corporate","shop","content","api","admin","download"]
updated_atstring Updated at
read-only
upidinteger User package id (may be empty before the package domain goes live; falls back to tenant_id in the snapshot when empty).
upidsinteger[] Only sites under any of these user packages; may be combined with upid (both must hold).
verdictstring Result for the caller visiting the home page: pass, block (blocked) or log (logged only).
Values ["pass","block","log"]
waf_gateSiteWafGate 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.
read-only
waf_gate_reasonWafGateReason 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.
read-onlyValues ["package","license","expired"]
with_domainboolean When true, the response also returns items (each site's ID and first domain) so batch editing can list the selected sites.
with_idsboolean 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.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "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"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command