Whatever the console does,
your code can do.
471 endpoints mirror the operations in the console: API-key authentication, one consistent error format, ready to plug into your release system, ops platform or AI assistant.
$ curl -X POST "https://panel.example.com/api/v2/cache-jobs" \ -H "X-API-Key: $GOCDN_API_KEY" \ -H "Content-Type: application/json" \ -d '{"type":"purge_url","urls":["https://www.example.com/index.html"]}' # Response · the key is a placeholder {"id":1,"name":"example"}
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
- 1X-API-Key is checked first (not expired or deleted)
- 2otherwise the Authorization: Bearer access token
- 3then the key scopes and the operation scope (tenants only reach their own resources)
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.
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"
}17 groups,
471 endpoints.
Browse resources by group; open one to see its endpoints, fields and example calls.
Authentication1 resources · 1 endpoints
User accounts4 resources · 23 endpoints
usersAdmins manage platform accounts: create, view, update, enable/disable, reset passwords, turn off TOTP. An account must be disabled before it can be deleted.13 endpointsCurrent usermeThe signed-in user views or edits their own profile and real-name verification.4 endpointsAPI keysapi-keysAPI keys of the current user. The plaintext key is returned only once at creation, and scopes can be limited per domain.4 endpointsIdentity verification channelscertify-channelsAdmin 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.2 endpointsBilling8 resources · 26 endpoints
accountThe current users own balance and freeze status; admins manage other users accounts through the user account endpoints.2 endpointsOrdersordersOrders 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.4 endpointsLedger entriesledger-entriesEvery change to an account balance, each with a balance snapshot taken after posting.1 endpointsOnline paymentspaymentsStart an online recharge: creates an unpaid order, pre-orders it at the payment gateway and returns the payment URL.3 endpointsRecharge methodspayment-methodsThe currently enabled online payment methods, the default method and transfer instructions, used to render the recharge page.1 endpointsPayment channelspayment-channelsAdmin settings for which gateway each payment method uses and each gateways merchant parameters; secrets are write-only.3 endpointsUSDT transfersusdt-transfersEach on-chain transfer into the USDT receiving addresses; those not matching an order are credited or ignored by admins.3 endpointsCurrency settingssettingsAdmin settings for the currency table (enabled, rate, rounding), the base currency and the default for new users; confirming the pre-upgrade accounting currency after upgrading from an old version.9 endpointsDNS and access4 resources · 23 endpoints
dns-providersAdmin 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.6 endpointsCNAME access domainscname-domainsAdmin 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.15 endpointsLine tag domainsline-tag-domainsAdmin only. Access root domains (excluding retiring ones) to pick from for node line tags, with provider edition and line granularity.1 endpointsDNS syncdns-syncAdmin only. Makes the scheduler reconcile all DNS records against the desired state right away (the Record repair button in the panel).1 endpointsNode scheduling10 resources · 38 endpoints
regionsGeographic regions used to categorize nodes and node groups.5 endpointsNodesnodesApproved edge nodes and sub-IPs; primary nodes self-enroll with an enrollment token, while sub-IPs are added manually by an admin.10 endpointsPending nodespending-nodesNodes that have enrolled with a token and await admin approval; once approved they become regular nodes.3 endpointsNode enrollment tokensnode-enroll-tokensGenerates a one-time enrollment token and a one-line node install command, and looks up by id whether a node has used the token; the token is returned only once, when generated.2 endpointsNode groupsnode-groupsGroups lines under one access name; a backup threshold can switch to the backup group automatically when usable lines run low.9 endpointsLineslinesA 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.5 endpointsNode line tagsnode-line-tagsEach primary node picks one access root domain and some of its lines; when setting up resolution, nodes tagged with the current line are preselected.1 endpointsAlert rulesalert-rulesBuilt-in alert rules of the control plane with their current settings and status; thresholds are changed via system settings.1 endpointsAlertsalertsRecent alert and recovery events, kept for 30 days.1 endpointsNode monitor logsmonitor-logsResults of each probe round the control plane runs against monitored node IPs.1 endpointsIP product line2 resources · 20 endpoints
Certificates6 resources · 31 endpoints
certsUploaded or automatically issued HTTPS certificates. They can be bound to sites; a certificate in use by a site cannot be deleted or disabled.14 endpointsACME accountsacme-accountsCA accounts used for automatic issuance (Let's Encrypt, ZeroSSL). Registered with the CA on first issuance.5 endpointsDNS API (cert validation)dns-apisDNS provider API credentials used for DNS-01 validation and wildcard certificates. Credentials are write-only; responses return only masks.5 endpointsCertificate settingscert-settingsThe current user's default certificate type for new certificates; leave empty to follow the platform.2 endpointsPanel certificatepanel-certAdmin 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.2 endpointsFile validationpki-validationsAdmin only. Provides content for the CA file validation, answered by nodes via the controller; no longer served after expiry.3 endpointsProtection22 resources · 85 endpoints
aclsRule sets that allow or block requests by IP/CIDR and other conditions; the platform provides built-in rules and tenants can create their own.6 endpointsCC matcherscc-matchesConditions that identify requests in CC protection; reusable across rule groups.6 endpointsCC filterscc-filtersHow matched requests are handled: rate limiting or a challenge (JS, slider, captcha and so on).5 endpointsCC rulescc-rulesOrdered combinations of matchers and filters; a site can pick one rule group.6 endpointsBansbansRecords 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.8 endpointsSite IP listssite-ip-listsPermanent 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.7 endpointsGlobal IP listsglobal-ip-listsPlatform-wide IP blacklist and whitelist with optional expiry, reason and source per entry, plus bulk import and export; admin only.4 endpointsCC settingscc-settingsPlatform-level default CC rule group and automatic switching settings; admin only.2 endpointsBot settingsbot-settingsPlatform-wide bot management: the action per class (search engine / monitor and tool / automation tool / AI crawler / 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.2 endpointsBot statsbot-statsStats 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.1 endpointsWAF settingswaf-settingsPlatform-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.2 endpointsUpload scan settingsupload-scan-settingsPlatform-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.2 endpointsUpload scan statsupload-scan-statsStats 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.1 endpointsHigh-risk IP libraryintelThe 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.7 endpointsValue-added protection schemesprotect-schemesOne 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.10 endpointsReplay protectionsite-replay-guardsReplay 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.3 endpointsData leak protectionsite-leak-guardsData 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.3 endpointsNetwork-wide URL protection settingsurl-guard-settingsPlatform-wide default switch and thresholds for network-wide URL protection; admin only. Per-site switch and thresholds live in the site security settings.2 endpointsNetwork-wide URL protectionurl-guardTemporary 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.1 endpointsThreat intelligence reportsintel-reportsBatches 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.1 endpointsWeb tamper protectionsite-tamper-guardsWeb 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.5 endpointsWeb tamper protection page overviewtamper-guardAll 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.1 endpointsPackages7 resources · 40 endpoints
packagesBase packages for sale, defining quotas such as traffic, bandwidth and domains, and prices.8 endpointsPackage groupspackage-groupsGroups that organize packages so customers can browse and choose.6 endpointsAdd-onspackage-upgradesQuotas or features bought per unit on top of a base package.5 endpointsPackage catalogpackage-catalogThe catalog of packages, groups and add-ons a customer can buy.1 endpointsPurchased packagesuser-packagesPackages a tenant has bought: purchase, renew, change, buy add-ons and view usage.17 endpointsPackage ownersuser-package-ownersAdmin only: purchased packages grouped by user (package counts, expiry stats, tab counts).1 endpointsPackage monitorpackage-monitorAdmin only: bandwidth and connections of each purchased package over the last minute.2 endpointsSites2 resources · 35 endpoints
Cache6 resources · 21 endpoints
cache-groupsA set of cache rules that many sites can reference; either platform groups or tenant-owned groups.7 endpointsCache policycache-policySets the tenant's default cache group and can reset all sites to follow it.4 endpointsCache presetscache-presetsFactory default cache rules, usable as a reference when creating a cache group.1 endpointsSite cache group and per-site changescache-sitesView or set the cache group used by one site and its per-site changes (added, modified, deleted rules and the ignore-params list).5 endpointsPurge and prefetchcache-jobsPurge cached URLs or directories, and prefetch given URLs.3 endpointsPurge and prefetch quotacache-quotaDaily purge and prefetch limits and today's usage.1 endpointsTCP/UDP forwarding2 resources · 11 endpoints
streamsTCP/UDP port forwarding rules. Each rule has listen ports and protocols, an origin list and a balancing method; (protocol, port) is unique platform-wide.6 endpointsForwarding groupsstream-groupsGroups that organize forwarding rules for bulk management. Group names are unique per tenant, and a group that still has rules cannot be deleted.5 endpointsTiered origin1 resources · 25 endpoints
XDP fast blocking1 resources · 7 endpoints
Messages4 resources · 18 endpoints
messagesIn-app messages and announcements; admins publish announcements and tenants read and mark them as read.7 endpointsMessage subscriptionsmessage-subscriptionsChoose which notification types to receive.2 endpointsDelivery channelsmessage-channelsConfigure and test the email (SMTP) and SMS delivery channels.3 endpointsAlert webhooksmessage-webhooksDingTalk, Feishu, WeCom, Telegram and generic JSON alert outputs; several can be configured, and addresses and secrets show only the last 4 characters.6 endpointsTickets5 resources · 24 endpoints
ticketsAdmins handle user tickets: list, details, replies, internal notes, closing and reopening.8 endpointsMy ticketsmy-ticketsUsers submit, reply to, close, rate and reopen their own tickets.8 endpointsTicket imagesticket-imagesUpload and authenticated download of ticket images.2 endpointsTicket settingsticket-settingsAuto-close, reminder, reopen window and rating switch.2 endpointsTicket quick repliesticket-quick-repliesGlobal quick replies for admins.4 endpoints