EdgeNext Documentation

API Endpoint

Request URL: domain/list (GET)

API Host:cdn.api.edgenext.com

API Version:v2

Description

Retrieves basic information of domains under your account.

API rate limits are returned in the Response Headers.

Input Parameters

Public Parameters: Contact the on-duty support engineer to obtain your API token.

Request Parameters (GET)

Append the following parameters to the URL query string. For example:

?key1=value1&key2=value2

Parameter	Type	Required	Description
page_number	int	No	Specifies the page number to retrieve.Default: 1 if not specified.
page_size	int	No	Specifies the number of items per page. Valid range: 1-500.Default: 100 if not specified.
domain_status	string	No	Filters domains by service status. Multiple statuses separated by commas are supported.serving — In service. When filtering by serving, domains with status = deploying in the response are in configuration deployment state.suspend — Suspendeddeleted — DeletedDefault: returns basic information of domains in all statuses if not specified.

Request Example

# URL-encode the request parameters before sending the request.
curl -X GET "https://cdn.api.edgenext.com/v2/domain/list?token=xxx\
&page_number=1\
&page_size=50\
&domain_status=suspend,serving"

Response Example

{
    "code": 0, // A value of 0 indicates that the request was successful. A non-zero value indicates an error.
    "data": {
        "list": [
            {
                "id": "4612392",
                "domain": "example.com", // Domain
                "type": "page", // Domain type: `page` (Webpage) | `download` (Download) | `video_demand` (VOD) | `dynamic` (Dynamic content) | `video_live` (Live streaming)
                "status": "suspend",
                "cname": "example.com.edgenext.com.",
                "icp_status": "yes", // ICP filing status: `checking` (Verifying) | `yes` (Filed) | `no` (Not filed)
                "icp_num": "shuICP 93014234号-2", // ICP filing number
                "https": 1, // HTTPS service status: `1` (Enabled) | `0` (Disabled)
                "create_time": "2019-12-17 17:11:35",
                "update_time": "2020-06-30 13:58:52",                
                "config": {
                    // Origin configuration
                    "origin": {
                        "default_master": "1.1.1.1", // Primary origin IP
                        "origin_mode": "default", // Origin mode
                        "ori_https": "no", // Whether to use HTTPS for origin-pull
                        "port": "" // Origin port. Defaults to 80 if empty.
                    }
                }
            },
            {
                "id": "4612393",
                "domain": "example2.com",
                "type": "page",
                "status": "serving",
                "cname": "example2.com.edgenext.com.",
                "icp_status": "yes",
                "icp_num": "shuICP 93014233号-1",
                "https": 1, // HTTPS service status: `1` (Enabled) | `0` (Disabled)
                "create_time": "2019-11-17 17:11:35",
                "update_time": "2020-05-30 13:58:52", 
                "config": {
                    "origin": {
                        "default_master": "22.22.22.22",
                        "origin_mode": "https", // Origin mode
                        "ori_https": "yes", // Whether to use HTTPS for origin-pull
                        "port": "443", // Origin port. Defaults to 80 if empty.
                        "dx_master": "1.2.1.2"
                    }
                }
            }
        ],
        "page_size": 100, // Items per page
        "page_number": "1", // Current page number
        "total_number": "33960" // Total number of records matching the query parameters
    }
}

Response Headers

HTTP/1.0 200 OK
Api-Id:                112006099
Content-Type:          application/json; charset=utf-8
X-Ratelimit-Grad:      minute        // Rate limit interval (minute/hour/day)
X-Ratelimit-Limit:     300           // Maximum requests allowed during the current interval
X-Ratelimit-Remaining: 300           // Remaining requests available during the current interval
X-Retry-After:         53            // Number of seconds until the rate limit resets