API Documents
Contents
    Loading
Documentation API Documents Get The Domain List

Get The Domain List

1. API Description

This API (Domain.List) is used to get the domain list.
Domain name for API request:https://api.dnspod.com/Domain.List
HTTP request method: POST

2. Request Parameters

The table below lists only the API request parameters. Common request parameters are required when the API is called. For more information, please see Common Request Parameters.

Parameter Required Description
type no The domain type.Optional parameter.Default value:’all’.
offset no The offset of the response.Optional parameter.The first domain is numbered as 0.
length no The number of domains you want to get on this request.Optional parameter.
group_id no The group ID.Only in this group can the domain be in the results if this parameter is set.Optional parameter.

Domain name group type, including the following types:

  • all:All the domains
  • mine:Only mine.
  • share:Domains that shared with me.
  • ismark:Marked domains.
  • pause:Paused domains.
  • vip:VIP domains.
  • recent:Domains operated recently.
  • share_out:Domains that I shared out.

Attention:
If there are more than 500 domains in your account,only the first 500 domains will responded for split page.You may need to set the parameter “offset” and “length” to get all your domains with multi requests.

3. Response Codes

Only the response codes related to this API are listed below. For other response codes, please see Common Return Codes.

Response Code Description
6 Common Response Codes.
7 Invalid offset.
9 Empty result.

4. Sample

curl -X POST https://api.dnspod.com/Domain.List -d 'user_token=730060,e1a8a$f14dc5dcbafd83680b3d2a553c4d553d&format=json'

The following is a sample response:

  • JSON:
{
    "status": {
        "code": "1",
        "message": "Action completed successful",
        "created_at": "2014-06-04 21:22:08"
    },
    "info": {
        "domain_total": 1,
        "all_total": 1,
        "mine_total": 1,
        "share_total": 0,
        "vip_total": 0,
        "ismark_total": 0,
        "pause_total": 0,
        "error_total": 1,
        "lock_total": 0,
        "spam_total": 0,
        "vip_expire": 0,
        "share_out_total": 0
    },
    "domains": [
        {
            "id": 6,
            "name": "dnspod.com",
            "grade": "DP_Free",
            "grade_title": "Free",
            "status": "enable",
            "ext_status": "notexist",
            "records": "3",
            "group_id": "1",
            "is_mark": "no",
            "remark": "",
            "is_vip": "no",
            "searchengine_push": "yes",
            "beian": "no",
            "created_on": "2014-06-04 16:19:31",
            "updated_on": "2014-06-04 16:20:05",
            "ttl": "600",
            "owner": "yizero@qq.com"
        }
    ]
}
Last updated on 2020-12-23 07:25

DNSPod Technical Community

Sharing & discussions

Scan using WeChat

Official WeChat group

Join WeChat group to chat and feedback

Scan using WeChat