Version 2.1.1792967583 · latest Download OpenAPI Markdown

DNS API (cert validation)

DNS provider API credentials used for DNS-01 validation and wildcard certificates. Credentials are write-only; responses return only masks.

dns-apisCertificatesAuthentication: User (some parameters admin only)5 endpoints

List DNS API credentials

GET/api/v2/dns-apis

Authentication: User (some parameters 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`
tenant_id	integer	—	Admin only: filter by tenant. Ignored for tenant credentials, which only see their own tenant's data

Create DNS API credential

POST/api/v2/dns-apis

Authentication: User (some parameters admin only)

Query parameters

Field	Type	Required	Description
tenant_id	integer	—	Admin only: filter by tenant. Ignored for tenant credentials, which only see their own tenant's data

Request body application/json

Field	Type	Required	Description
auth	object	—	Credential key name to mask (last 4 chars shown as `**abcd` when 16+ chars, otherwise `******`); plaintext is never returned.
des	string	—	Description
name	string	Required	Name
type	string	Required	DNS provider.

Get DNS API credential

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

Authentication: User (some parameters admin only)

Update DNS API credential

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

Authentication: User (some parameters admin only)

Request body application/json

Field	Type	Required	Description
auth	object	—	Credential key name to mask (last 4 chars shown as `**abcd` when 16+ chars, otherwise `******`); plaintext is never returned.
des	string	—	Description
name	string	Required	Name
type	string	Required	DNS provider.

Delete DNS API credential

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

Authentication: User (some parameters admin only)

DNS API (cert validation) object

Field	Type	Required	Description
auth	object	—	Credential key name to mask (last 4 chars shown as `**abcd` when 16+ chars, otherwise `******`); plaintext is never returned.
created_at	string	—	Created at read-only
des	string	—	Description
id	integer	—	Record ID read-only
name	string	—	Name
tenant_id	integer	—	Owner tenant (user) ID read-only
type	string	—	DNS provider.
updated_at	string	—	Updated at read-only

curl

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

# Create DNS API credential
curl -X POST "https://panel.example.com/api/v2/dns-apis" \
  -H "X-API-Key: $GOCDN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"auth":{"DP_Id":"12345","DP_Key":"${DP_KEY}"},"name":"my-dns","type":"dnspod_cn"}'

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

# Update DNS API credential
curl -X PUT "https://panel.example.com/api/v2/dns-apis/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"auth":{"DP_Id":"12345","DP_Key":"${DP_KEY}"},"name":"my-dns","type":"dnspod_cn"}'

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