1. API Endpoint
https://openapi.dns.com/api/domain/lists/
2. Input Parameters
| Parameter |
Name |
Type |
Description |
| domain |
Query Domain |
string |
Optional |
| page |
Page Number |
int |
Page index, default is the first page |
| paginate |
Page Size |
int |
Number of records per page, default is 10 |
3. Output Parameters
| Parameter |
Name |
Type |
Description |
| code |
Return Code |
int |
0 means success; non-zero refers to error codes |
| message |
Message |
string |
If the operation succeeds, this may be empty; if it fails, an error message will be returned |
| data |
Response Data |
array |
If the API returns data, it will be in an array. If no data, it will be empty |
4. Data Field (data) Description
| Parameter |
Name |
Type |
Description |
| total |
Total Domains |
int |
The total number of domains returned on success |
| data |
Domain Array |
array |
The array of domains returned on success |
| data.domain_id |
Domain ID |
int |
- |
| data.domain |
Domain |
string |
- |
| data.product_id |
Domain Package ID |
int |
- |
| data.product_name |
Domain Package |
string |
- |
| data.created_at |
Creation Time |
string |
- |
| data.end_time |
Package End Time |
string |
- |
| data.status |
Domain Status |
int |
1 = Active, 2 = Suspended, 3 = System Suspended |
| data.group_id |
Domain Group ID |
int |
- |
| data.group_name |
Domain Group |
string |
- |