# gocdn

> A private-deployment CDN solution: caching and acceleration, HTTPS, CC and WAF protection, and real-time monitoring on your own servers.

私有化部署的 CDN 解决方案：基于自有服务器提供缓存加速、HTTPS、CC 与 WAF 防护和实时监测。

## Pricing

- [Pricing (English)](https://cdn.qiyun8.cc/en/pricing): Starter $15/mo, Professional $45/mo, Enterprise $129/mo
- [价格(中文)](https://cdn.qiyun8.cc/zh/pricing): 入门版 ¥99/月、专业版 ¥299/月、企业版 ¥899/月
- [plans.json](https://cdn.qiyun8.cc/data/plans.json): machine-readable plans and prices

## FAQ

- [FAQ (English)](https://cdn.qiyun8.cc/en/faq)
- [常见问题](https://cdn.qiyun8.cc/zh/faq)

## Features

- [Features overview (English)](https://cdn.qiyun8.cc/en/features): Caching and acceleration, HTTPS certificates, CC and WAF protection, live monitoring and multi-node operations: everything gocdn offers.
- [功能总览(中文)](https://cdn.qiyun8.cc/zh/features): 缓存加速、HTTPS 证书、CC 与 WAF 防护、实时监测与多节点运维：gocdn 的全部功能一览。
- [Tiered origin (L2)](https://cdn.qiyun8.cc/en/features/tiered-cache): gocdn tiered origin (L2): edge misses ask a regional L2 node first, cutting origin requests by about half in our tests.

## Product

- [Security](https://cdn.qiyun8.cc/en/security): Six layers on the edge node: access lists, CC, bots, WAF, upload scanning and auto-ban. With Rules Update, vulnerability patches, emergency rules and the high-risk IP library sync hourly.
- [安全防护](https://cdn.qiyun8.cc/zh/security): 名单、CC、Bot、WAF、上传扫描、自动封禁六层防护，都在节点上完成；开通规则更新后，漏洞补丁、应急规则与高危 IP 库每小时同步。
- [gocdn user guide](https://cdn.qiyun8.cc/en/guide/): How-tos organized by console menu, each with real screenshots. If an answer is not listed, consult the FAQ or contact us.
  - [10-minute quick start](https://cdn.qiyun8.cc/en/guide/quickstart.md): From a bare server to your first site on the CDN: install the controller, log in, install a node, add a site, update DNS, see the result.
  - [Architecture](https://cdn.qiyun8.cc/en/guide/arch.md): The controller manages config and analytics, nodes carry site traffic: get these two roles straight and everything else follows.
  - [Install the controller](https://cdn.qiyun8.cc/en/guide/install-master.md): Install the controller with one command: requirements, what the installer does, how to log in and verify.
  - [Add nodes](https://cdn.qiyun8.cc/en/guide/add-node.md): Get a command from the panel, run it on a new machine, approve it and the node comes up by itself; requirements, ports and FAQ.
  - [Online upgrades](https://cdn.qiyun8.cc/en/guide/upgrade.md): Upgrade the controller and nodes from the panel: pre-checks, staged and one-click upgrades, automatic rollback on failure.
  - [Uninstall and migrate](https://cdn.qiyun8.cc/en/guide/migrate.md): Uninstall nodes and the controller, keep or purge data, and migrate the controller to a new machine from a backup.
  - [Add a site](https://cdn.qiyun8.cc/en/guide/add-site.md): Add a site with its domain and origin, get the CNAME target after saving; bulk add and common errors.
  - [Set up the CNAME record](https://cdn.qiyun8.cc/en/guide/cname.md): Point the domain at the address gocdn gives you with a CNAME at your DNS provider, and check that it works.
  - [HTTPS certificates](https://cdn.qiyun8.cc/en/guide/https.md): Request a free certificate or upload your own, then turn on HTTPS, forced redirect, HTTP/2 and HTTP/3.
  - [Cache rules](https://cdn.qiyun8.cc/en/guide/cache.md): Use cache rules to decide what is cached and for how long; by group or custom, and how to raise the hit ratio.
  - [Purge and prefetch](https://cdn.qiyun8.cc/en/guide/purge.md): After content changes, purge makes nodes drop old cache; prefetch pulls popular content to nodes ahead of time.
  - [Origin settings](https://cdn.qiyun8.cc/en/guide/origin.md): Set the origin protocol and port, how several origins share traffic and their weights, and allow nodes through the origin firewall.
  - [Security overview and big screen](https://cdn.qiyun8.cc/en/guide/overview.md): The security overview shows protection status and to-dos, the big screen puts the posture on a duty-room wall, and the site check finds configuration risks.
  - [Attack log](https://cdn.qiyun8.cc/en/guide/events.md): See requests blocked or challenged by the WAF, CC, Bot and more, filter them, and allowlist wrongly blocked IPs.
  - [CC protection](https://cdn.qiyun8.cc/en/guide/cc.md): Choose a CC protection level, custom rules and challenge types against high-frequency requests and API abuse.
  - [WAF](https://cdn.qiyun8.cc/en/guide/waf.md): Basic WAF switch, observe and block modes, and handling false positives with exceptions.
  - [Lists and access control](https://cdn.qiyun8.cc/en/guide/lists.md): IP allow/deny lists, region limits, access control rules and hotlink protection, to decide precisely who gets in.
  - [Bots and scanners](https://cdn.qiyun8.cc/en/guide/bot.md): Identify and handle crawlers, automation tools and vulnerability scanners, and automatically ban IPs that keep triggering.
  - [Paid protection add-ons](https://cdn.qiyun8.cc/en/guide/paid.md): What separates the free basic protection from WAF Plus and WAF Rules Update, and where to set them after enabling.
  - [Statistics](https://cdn.qiyun8.cc/en/guide/stats.md): Trends of bandwidth, traffic, requests and hit ratio, and rankings by site, forward or node.
  - [Access logs](https://cdn.qiyun8.cc/en/guide/logs.md): Query the details of every visit, filter by condition, and export or download log files.
  - [Alerts and notifications](https://cdn.qiyun8.cc/en/guide/alerts.md): See what is alerting, set alert rules and subscribe to messages.
  - [Users and plans](https://cdn.qiyun8.cc/en/guide/users.md): Administrators create users, assign plans and top up; users buy, renew and secure their own accounts.
  - [Licenses and add-ons](https://cdn.qiyun8.cc/en/guide/license.md): What the controller license does, its states and what happens at expiry; enabling and expiry of add-ons such as WAF Plus.
- [gocdn 使用手册](https://cdn.qiyun8.cc/zh/guide/): 按控制台菜单组织的操作说明，每篇配有实际界面截图。如未找到答案，请查阅常见问题或联系我们。
  - [10 分钟上手](https://cdn.qiyun8.cc/zh/guide/quickstart.md): 从一台空服务器到第一个网站走上 CDN:装主控、登录、装节点、加网站、改解析、看效果。
  - [整体架构](https://cdn.qiyun8.cc/zh/guide/arch.md): 主控管理配置与统计,节点承载网站流量:先弄清这两个角色,后面的操作就好理解。
  - [安装主控](https://cdn.qiyun8.cc/zh/guide/install-master.md): 一条命令装好主控:系统要求、安装做了什么、装完怎么登录与自检。
  - [添加节点](https://cdn.qiyun8.cc/zh/guide/add-node.md): 在面板取一条命令到新机器执行,审批后节点自动上线;含机器要求、端口与常见问题。
  - [在线升级](https://cdn.qiyun8.cc/zh/guide/upgrade.md): 在面板里升级主控与节点:升级前确认、灰度与一键升级、失败自动回退。
  - [卸载与迁移](https://cdn.qiyun8.cc/zh/guide/migrate.md): 卸载节点与主控、保留或清除数据,以及用备份把主控迁到新机器。
  - [添加网站](https://cdn.qiyun8.cc/zh/guide/add-site.md): 添加一个网站:填域名与源站,保存后拿到 CNAME 地址;批量添加与常见报错。
  - [配置 CNAME 解析](https://cdn.qiyun8.cc/zh/guide/cname.md): 到 DNS 服务商把域名 CNAME 到 gocdn 给出的地址,以及怎么确认已生效。
  - [HTTPS 证书](https://cdn.qiyun8.cc/zh/guide/https.md): 申请免费证书或上传自有证书,开启 HTTPS、强制跳转、HTTP/2 与 HTTP/3。
  - [缓存规则](https://cdn.qiyun8.cc/zh/guide/cache.md): 用缓存规则决定哪些内容缓存多久;按分组或自定义,以及提高命中率的做法。
  - [刷新与预热](https://cdn.qiyun8.cc/zh/guide/purge.md): 内容更新后用刷新让节点丢掉旧缓存,用预热提前把热门内容拉到节点。
  - [回源设置](https://cdn.qiyun8.cc/zh/guide/origin.md): 设置回源协议与端口、多个源站的分配方式与权重,以及源站防火墙放行节点。
  - [安全总览与大屏](https://cdn.qiyun8.cc/zh/guide/overview.md): 安全总览看防护概况与待处理项,大屏把态势投到值班墙上;网站体检找出配置风险。
  - [攻击记录](https://cdn.qiyun8.cc/zh/guide/events.md): 查看被 WAF、CC、Bot 等拦截或验证的请求,按条件筛选,加白误拦的 IP。
  - [CC 防护](https://cdn.qiyun8.cc/zh/guide/cc.md): 选择 CC 防护档位、自定义规则与验证方式,应对高频请求与刷接口。
  - [WAF](https://cdn.qiyun8.cc/zh/guide/waf.md): 基础 WAF 的开关、观察与拦截模式,以及用例外处理误报。
  - [名单与访问控制](https://cdn.qiyun8.cc/zh/guide/lists.md): IP 黑白名单、地区限制、访问控制规则与防盗链,精确决定谁能访问。
  - [Bot 与扫描器](https://cdn.qiyun8.cc/zh/guide/bot.md): 识别并处置爬虫、自动化工具与漏洞扫描器,自动封禁连续触发的 IP。
  - [增值防护](https://cdn.qiyun8.cc/zh/guide/paid.md): 免费基础防护与 WAF 增强、规则更新的区别,以及开通后在哪里设置。
  - [统计分析](https://cdn.qiyun8.cc/zh/guide/stats.md): 看带宽、流量、请求数与命中率的趋势,按网站、转发或节点查看排行。
  - [访问日志](https://cdn.qiyun8.cc/zh/guide/logs.md): 查询每一次访问的明细,按条件筛选,导出或下载日志文件。
  - [告警通知](https://cdn.qiyun8.cc/zh/guide/alerts.md): 看正在告警的项目,设置告警规则,订阅消息通知。
  - [用户与套餐](https://cdn.qiyun8.cc/zh/guide/users.md): 管理员创建用户、分配套餐与充值;用户自助购买、续费与设置账号安全。
  - [授权与增值功能](https://cdn.qiyun8.cc/zh/guide/license.md): 主控授权的作用、状态与到期处理;WAF 增强等增值功能的开通与到期。
- [Changelog](https://cdn.qiyun8.cc/en/changelog): New features, improvements and fixes in every gocdn release.
- [更新日志](https://cdn.qiyun8.cc/zh/changelog): gocdn 每个版本的新功能、改进与修复。

## API reference (v2.2.4)

- [API reference](https://cdn.qiyun8.cc/en/docs/api)
- [Full API reference as Markdown](https://cdn.qiyun8.cc/en/docs/api.md)
- [接口文档 Markdown](https://cdn.qiyun8.cc/zh/docs/api.md)
- [OpenAPI 3 (JSON)](https://cdn.qiyun8.cc/openapi.json)
- [Authentication](https://cdn.qiyun8.cc/en/docs/api/auth.md): Login, token refresh, logout, password change, TOTP, password reset, captcha and admin SSO. Login endpoints need no authentication.
- [Users](https://cdn.qiyun8.cc/en/docs/api/users.md): Admins manage platform accounts: create, view, update, enable/disable, reset passwords, turn off TOTP. An account must be disabled before it can be deleted.
- [Current user](https://cdn.qiyun8.cc/en/docs/api/me.md): The signed-in user views or edits their own profile, real-name verification and UI preferences.
- [API keys](https://cdn.qiyun8.cc/en/docs/api/api-keys.md): API keys of the current user. The plaintext key is returned only once at creation, and scopes can be limited per domain.
- [Registration info](https://cdn.qiyun8.cc/en/docs/api/registration-info.md): No authentication needed. Returns whether registration is open, which fields are required or need verification, and the user agreement.
- [Registrations](https://cdn.qiyun8.cc/en/docs/api/registrations.md): No authentication needed. Submits registration details to create a tenant account; the agreement must be accepted and verified email or phone needs a code.
- [Verification codes](https://cdn.qiyun8.cc/en/docs/api/verify-codes.md): No authentication needed. Sends email or SMS codes for binding at registration, password reset and second-factor login; SMS needs a captcha.
- [Login policy](https://cdn.qiyun8.cc/en/docs/api/login-policy.md): No authentication needed. Tells whether an account needs an email or SMS code to log in, with the masked destination.
- [Identity verification channels](https://cdn.qiyun8.cc/en/docs/api/certify-channels.md): Admin only: merchant credentials of Alipay identity verification and Tencent Cloud FaceID (WeChat face verification); the channel in use is chosen by certify_provider in account settings.
- [Account](https://cdn.qiyun8.cc/en/docs/api/account.md): The current users own balance and freeze status; admins manage other users accounts through the user account endpoints.
- [Orders](https://cdn.qiyun8.cc/en/docs/api/orders.md): Orders created by recharges, deductions, online payments and package purchases; tenants see only their own, admins can see all tenants, and only the remark can be edited.
- [Ledger entries](https://cdn.qiyun8.cc/en/docs/api/ledger-entries.md): Every change to an account balance, each with a balance snapshot taken after posting.
- [Online payments](https://cdn.qiyun8.cc/en/docs/api/payments.md): Start an online recharge: creates an unpaid order, pre-orders it at the payment gateway and returns the payment URL.
- [Recharge methods](https://cdn.qiyun8.cc/en/docs/api/payment-methods.md): The currently enabled online payment methods, the default method and transfer instructions, used to render the recharge page.
- [Payment channels](https://cdn.qiyun8.cc/en/docs/api/payment-channels.md): Admin settings for which gateway each payment method uses and each gateways merchant parameters; secrets are write-only.
- [Payment notifications](https://cdn.qiyun8.cc/en/docs/api/payment-notifications.md): Result notification endpoint called by payment gateways; no authentication, signature verified per gateway rules, and repeated notifications are credited only once.
- [DNS providers](https://cdn.qiyun8.cc/en/docs/api/dns-providers.md): Admin only. Stores DNS provider accounts (such as Alibaba Cloud or Cloudflare); credentials are verified online before saving and only the last 4 characters are ever returned.
- [CNAME access domains](https://cdn.qiyun8.cc/en/docs/api/cname-domains.md): Admin only. Root domains used to build CNAME access names, each owned by a DNS provider account; supports migrating everything to a new root domain and checking whether customers have switched their records.
- [DNS sync](https://cdn.qiyun8.cc/en/docs/api/dns-sync.md): Admin only. Makes the scheduler reconcile all DNS records against the desired state right away (the Record repair button in the panel).
- [Regions](https://cdn.qiyun8.cc/en/docs/api/regions.md): Geographic regions used to categorize nodes and node groups.
- [Nodes](https://cdn.qiyun8.cc/en/docs/api/nodes.md): Approved edge nodes and sub-IPs; primary nodes self-enroll with an enrollment token, while sub-IPs are added manually by an admin.
- [Pending nodes](https://cdn.qiyun8.cc/en/docs/api/pending-nodes.md): Nodes that have enrolled with a token and await admin approval; once approved they become regular nodes.
- [Node enrollment tokens](https://cdn.qiyun8.cc/en/docs/api/node-enroll-tokens.md): Generates a one-time enrollment token and a one-line node install command; the token is returned only once, when generated.
- [Node groups](https://cdn.qiyun8.cc/en/docs/api/node-groups.md): Groups lines under one access name; a backup threshold can switch to the backup group automatically when usable lines run low.
- [Lines](https://cdn.qiyun8.cc/en/docs/api/lines.md): A resolution record in a node group, showing which DNS line and weight a node appears with; a line must be disabled before it can be deleted.
- [Alert rules](https://cdn.qiyun8.cc/en/docs/api/alert-rules.md): Built-in alert rules of the control plane with their current settings and status; thresholds are changed via system settings.
- [Alerts](https://cdn.qiyun8.cc/en/docs/api/alerts.md): Recent alert and recovery events, kept for 30 days.
- [Node monitor logs](https://cdn.qiyun8.cc/en/docs/api/monitor-logs.md): Results of each probe round the control plane runs against monitored node IPs.
- [IP pools](https://cdn.qiyun8.cc/en/docs/api/ip-pools.md): IP pools and the IPs inside them, maintained by admins. A pool belongs to a region and its name is unique platform-wide.
- [IP sites](https://cdn.qiyun8.cc/en/docs/api/ip-sites.md): Sites served on IPs with custom ports; the IPs must first be selected in the user package.
- [Certificates](https://cdn.qiyun8.cc/en/docs/api/certs.md): Uploaded or automatically issued HTTPS certificates. They can be bound to sites; a certificate in use by a site cannot be deleted or disabled.
- [ACME accounts](https://cdn.qiyun8.cc/en/docs/api/acme-accounts.md): CA accounts used for automatic issuance (Let's Encrypt, ZeroSSL). Registered with the CA on first issuance.
- [DNS API (cert validation)](https://cdn.qiyun8.cc/en/docs/api/dns-apis.md): DNS provider API credentials used for DNS-01 validation and wildcard certificates. Credentials are write-only; responses return only masks.
- [Certificate settings](https://cdn.qiyun8.cc/en/docs/api/cert-settings.md): The current user's default certificate type for new certificates; leave empty to follow the platform.
- [Panel certificate](https://cdn.qiyun8.cc/en/docs/api/panel-cert.md): Admin only. Status of the panel's own HTTPS certificate; one click issues a Let's Encrypt certificate for the panel domain, renewed with certificate management.
- [File validation](https://cdn.qiyun8.cc/en/docs/api/pki-validations.md): Admin only. Provides content for the CA file validation, answered by nodes via the controller; no longer served after expiry.
- [Access control lists](https://cdn.qiyun8.cc/en/docs/api/acls.md): Rule sets that allow or block requests by IP/CIDR and other conditions; the platform provides built-in rules and tenants can create their own.
- [CC matchers](https://cdn.qiyun8.cc/en/docs/api/cc-matches.md): Conditions that identify requests in CC protection; reusable across rule groups.
- [CC filters](https://cdn.qiyun8.cc/en/docs/api/cc-filters.md): How matched requests are handled: rate limiting or a challenge (JS, slider, captcha and so on).
- [CC rules](https://cdn.qiyun8.cc/en/docs/api/cc-rules.md): Ordered combinations of matchers and filters; a site can pick one rule group.
- [Bans](https://cdn.qiyun8.cc/en/docs/api/bans.md): Records of blocked IPs: bans created by hand, unban by IP or for a whole site with an unban history, and automatic bans reported by nodes.
- [Site IP lists](https://cdn.qiyun8.cc/en/docs/api/site-ip-lists.md): Permanent IP blacklist and whitelist of one site; blacklisted IPs are dropped and whitelisted IPs skip CC and other protections. The site's temporary whitelist on nodes can also be cleared.
- [Global IP lists](https://cdn.qiyun8.cc/en/docs/api/global-ip-lists.md): Platform-wide IP blacklist and whitelist with optional expiry, reason and source per entry, plus bulk import and export; admin only.
- [CC settings](https://cdn.qiyun8.cc/en/docs/api/cc-settings.md): Platform-level default CC rule group and automatic switching settings; admin only.
- [Bot settings](https://cdn.qiyun8.cc/en/docs/api/bot-settings.md): Platform-wide bot management: the action per class (search engine / monitor and tool / automation tool / headless browser / malicious bot) and for fake crawlers, the challenge kind, behaviour score bands, protected endpoints and exceptions; admin only. Headless browser, malicious bot and fake crawler actions plus behaviour scoring belong to the paid feature WAF enhanced. Each site may override per class in the site config field bot.
- [Bot stats](https://cdn.qiyun8.cc/en/docs/api/bot-stats.md): Stats at the top of the bot management page and the per-class "requests today" column: today's requests, requests and action breakdown per bot class, number of sites with replay protection on, and node upgrade progress; tenants see their own sites only.
- [WAF settings](https://cdn.qiyun8.cc/en/docs/api/waf-settings.md): Platform-wide WAF master switch, default blocking threshold and request body inspection limit; admin only. Per-site observe/block mode and exceptions live in the site config field waf.
- [Upload scan settings](https://cdn.qiyun8.cc/en/docs/api/upload-scan-settings.md): Platform-wide upload scanning (files in multipart form uploads only): master switch, dangerous extensions, double extensions, disguised files, webshell signatures, antivirus, per-file limit, scan timeout, action and exceptions; admin only. Webshell signatures, antivirus and the sha256 blocklist belong to the paid feature WAF enhanced.
- [Upload scan stats](https://cdn.qiyun8.cc/en/docs/api/upload-scan-stats.md): Stats at the top of the upload scan page: today's scanned, blocked and over-limit unscanned counts, plus the list of sites that cannot be scanned; admin only.
- [High-risk IP library](https://cdn.qiyun8.cc/en/docs/api/intel.md): The platform-provided high-risk IP library (paid item rules update, synced hourly): status, platform-wide handling policy, entry lookup, whitelisting a single entry and today's visits that hit it; read-only for tenants.
- [Value-added protection schemes](https://cdn.qiyun8.cc/en/docs/api/protect-schemes.md): One scheme each for replay, data leak and web tamper protection (one per tenant; admins edit the platform scheme); saving also updates sites that follow the scheme, sites with their own settings are left alone; part of WAF Enhanced.
- [Replay protection](https://cdn.qiyun8.cc/en/docs/api/site-replay-guards.md): Replay protection of one site: protected APIs need a one-time token or the app signature headers, otherwise the request is blocked or challenged; can be set for the site alone or restored to the scheme; part of WAF Enhanced.
- [Data leak protection](https://cdn.qiyun8.cc/en/docs/api/site-leak-guards.md): Data leak protection of one site: checks pages, JSON and text returned by the origin for phone numbers, ID card numbers, bank card numbers, keys and error messages, and masks, blocks or replaces them with an error page; part of WAF Enhanced.
- [Network-wide URL protection settings](https://cdn.qiyun8.cc/en/docs/api/url-guard-settings.md): Platform-wide default switch and thresholds for network-wide URL protection; admin only. Per-site switch and thresholds live in the site security settings.
- [Network-wide URL protection](https://cdn.qiyun8.cc/en/docs/api/url-guard.md): Temporary challenge/rate-limit/block rules pushed for a URL once its cross-node request volume exceeds the threshold, revoked automatically on expiry; read-only view of the entries in effect.
- [Threat intelligence reports](https://cdn.qiyun8.cc/en/docs/api/intel-reports.md): Batches of threat intelligence this master reports anonymously to the vendor (auto-banned high-risk IPs, upload scan hits and false positives, newly seen file fingerprints), one batch every 5 minutes; nothing is reported while intelligence sharing is off. Admin only.
- [Web tamper protection](https://cdn.qiyun8.cc/en/docs/api/site-tamper-guards.md): Web tamper protection of one site: protected scopes (home page, pages, directories), what counts as tampering (structure only / any change), serving the baseline page or alerting only, and the observation period; baseline update and diff; part of WAF Enhanced.
- [Web tamper protection page overview](https://cdn.qiyun8.cc/en/docs/api/tamper-guard.md): All protected pages across sites (site, path, scope, baseline time, state, last change) without picking a site first; tenants see their own sites only and may filter by site.
- [Packages](https://cdn.qiyun8.cc/en/docs/api/packages.md): Base packages for sale, defining quotas such as traffic, bandwidth and domains, and prices.
- [Package groups](https://cdn.qiyun8.cc/en/docs/api/package-groups.md): Groups that organize packages so customers can browse and choose.
- [Upgrade packs](https://cdn.qiyun8.cc/en/docs/api/package-upgrades.md): Quotas or features bought per unit on top of a base package.
- [Package catalog](https://cdn.qiyun8.cc/en/docs/api/package-catalog.md): The catalog of packages, groups and upgrade packs a customer can buy.
- [Purchased packages](https://cdn.qiyun8.cc/en/docs/api/user-packages.md): Packages a tenant has bought: purchase, renew, change, add upgrade packs and view usage.
- [Package monitor](https://cdn.qiyun8.cc/en/docs/api/package-monitor.md): Admin only: bandwidth and connections of each purchased package over the last minute.
- [Sites](https://cdn.qiyun8.cc/en/docs/api/sites.md): CDN-accelerated sites. Creating one needs at least a domain and an origin; admins can manage any tenant's sites.
- [Site groups](https://cdn.qiyun8.cc/en/docs/api/site-groups.md): Groups for organizing sites; names are unique within a tenant and a group that still contains sites cannot be deleted.
- [Cache groups](https://cdn.qiyun8.cc/en/docs/api/cache-groups.md): A set of cache rules that many sites can reference; either platform groups or tenant-owned groups.
- [Cache policy](https://cdn.qiyun8.cc/en/docs/api/cache-policy.md): Sets the tenant's default cache group and can reset all sites to follow it.
- [Cache presets](https://cdn.qiyun8.cc/en/docs/api/cache-presets.md): Factory default cache rules, usable as a reference when creating a cache group.
- [Site cache mode](https://cdn.qiyun8.cc/en/docs/api/cache-sites.md): View or set the cache group or custom rules used by one site.
- [Purge and prefetch](https://cdn.qiyun8.cc/en/docs/api/cache-jobs.md): Purge cached URLs or directories, and prefetch given URLs.
- [Purge and prefetch quota](https://cdn.qiyun8.cc/en/docs/api/cache-quota.md): Daily purge and prefetch limits and today's usage.
- [TCP/UDP forwarding](https://cdn.qiyun8.cc/en/docs/api/streams.md): TCP/UDP port forwarding rules. Each rule has listen ports and protocols, an origin list and a balancing method; (protocol, port) is unique platform-wide.
- [Forwarding groups](https://cdn.qiyun8.cc/en/docs/api/stream-groups.md): Groups that organize forwarding rules for bulk management. Group names are unique per tenant, and a group that still has rules cannot be deleted.
- [Tiered origin (L2)](https://cdn.qiyun8.cc/en/docs/api/l2.md): Edges fetch through L2 nodes in their region first, so cached content no longer hits the origin. Paid feature l2; inactive when not licensed.
- [Messages](https://cdn.qiyun8.cc/en/docs/api/messages.md): In-app messages and announcements; admins publish announcements and tenants read and mark them as read.
- [Message subscriptions](https://cdn.qiyun8.cc/en/docs/api/message-subscriptions.md): Choose which notification types to receive.
- [Delivery channels](https://cdn.qiyun8.cc/en/docs/api/message-channels.md): Configure and test the email (SMTP) and SMS delivery channels.
- [Alert webhooks](https://cdn.qiyun8.cc/en/docs/api/message-webhooks.md): DingTalk, Feishu, WeCom, Telegram and generic JSON alert outputs; several can be configured, and addresses and secrets show only the last 4 characters.
- [Reports](https://cdn.qiyun8.cc/en/docs/api/reports.md): Real-time curves, rankings and usage for sites and TCP/UDP forwarding, node monitoring curves and rankings, unconfigured-domain Top, temporary whitelist and access logs; tenants see only their own data.

## Optional

- [Full text for LLMs](https://cdn.qiyun8.cc/llms-full.txt)