Version 2.1.1792967583 · latest Download OpenAPI Markdown

DNS providers

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.

dns-providersDNS and accessAuthentication: Admin only6 endpoints

List DNS providers

GET/api/v2/dns-providers

Authentication: Admin only

Query parameters

Field	Type	Required	Description
page	integer	—	Page number, starting from 1 Default `1`
page_size	integer	—	Items per page Default `20`
sort	string	—	Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`
type	string	—	Only list providers of this type (such as aliyun).

Create DNS provider

POST/api/v2/dns-providers

Authentication: Admin only

Request body application/json

Field	Type	Required	Description
auth_id	string	—	Credential ID (Alibaba Cloud AccessKey ID, DNSPod Token ID or Tencent Cloud SecretId, Cloudflare email; empty when a Cloudflare API Token is used).
auth_key	string	—	Credential (AccessKey Secret / Token / SecretKey / API Key); required on create, omitted or empty on update = keep the existing value. Stored encrypted.
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; ignored on create.
gateway	string	—	Self-hosted API gateway address (used by dnsdun only).
name	string	Required	Name
remark	string	—	Remark
ttl	integer	—	Default TTL (seconds) of records under this account.
type	string	Required	Provider type: aliyun, cloudflare, dnspod_cn, dnspod_com, dns_la, dnsdotcom, dnsdun.

Get DNS provider

GET/api/v2/dns-providers/{id}

Authentication: Admin only

Update DNS provider

PUT/api/v2/dns-providers/{id}

Authentication: Admin only

Request body application/json

Field	Type	Required	Description
auth_id	string	—	Credential ID (Alibaba Cloud AccessKey ID, DNSPod Token ID or Tencent Cloud SecretId, Cloudflare email; empty when a Cloudflare API Token is used).
auth_key	string	—	Credential (AccessKey Secret / Token / SecretKey / API Key); required on create, omitted or empty on update = keep the existing value. Stored encrypted.
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; ignored on create.
gateway	string	—	Self-hosted API gateway address (used by dnsdun only).
name	string	Required	Name
remark	string	—	Remark
ttl	integer	—	Default TTL (seconds) of records under this account.
type	string	Required	Provider type: aliyun, cloudflare, dnspod_cn, dnspod_com, dns_la, dnsdotcom, dnsdun.

Delete DNS provider

DELETE/api/v2/dns-providers/{id}

Authentication: Admin only

Fetch DNS provider lines

GET/api/v2/dns-providers/{id}/lines

Authentication: Admin only

Query parameters

Field	Type	Required	Description
domain	string	Required	Root domain, such as example.com.

DNS providers object

Field	Type	Required	Description
auth_id	string	—	Credential ID (Alibaba Cloud AccessKey ID, DNSPod Token ID or Tencent Cloud SecretId, Cloudflare email; empty when a Cloudflare API Token is used).
auth_key	string	—	Credential (AccessKey Secret / Token / SecretKey / API Key); required on create, omitted or empty on update = keep the existing value. Stored encrypted.
auth_key_hint	string	—	Last 4 characters of the credential (padded with * in front); the original is never returned.
created_at	string	—	Created at read-only
default_line	string	—	ID of the default line of this provider.
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; ignored on create.
gateway	string	—	Self-hosted API gateway address (used by dnsdun only).
id	integer	—	Record ID read-only
items	DnsLine[]	—	Items on this page
lines	DnsLine[]	—	Cached line tree from the last fetch (refreshed by GET /dns-providers/{id}/lines); an empty array if never fetched.
name	string	—	Name
remark	string	—	Remark
ttl	integer	—	Default TTL (seconds) of records under this account.
type	string	—	Provider type: aliyun, cloudflare, dnspod_cn, dnspod_com, dns_la, dnsdotcom, dnsdun.
updated_at	string	—	Updated at read-only

curl

# List DNS providers
curl "https://panel.example.com/api/v2/dns-providers" \
  -H "X-API-Key: $GOCDN_API_KEY"

# Create DNS provider
curl -X POST "https://panel.example.com/api/v2/dns-providers" \
  -H "X-API-Key: $GOCDN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"auth_id":"LTAI-example","auth_key":"${DNS_AUTH_KEY}","name":"main-aliyun","ttl":120,"type":"aliyun"}'

# Get DNS provider
curl "https://panel.example.com/api/v2/dns-providers/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY"

# Update DNS provider
curl -X PUT "https://panel.example.com/api/v2/dns-providers/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"auth_id":"LTAI-example","auth_key":"${DNS_AUTH_KEY}","name":"main-aliyun","ttl":120,"type":"aliyun"}'

# Delete DNS provider
curl -X DELETE "https://panel.example.com/api/v2/dns-providers/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY"

# Fetch DNS provider lines
curl "https://panel.example.com/api/v2/dns-providers/{id}/lines" \
  -H "X-API-Key: $GOCDN_API_KEY"