Get a List of Domains
The Get a List of Domains method returns a List of Domains.
GET /api/vendor/v1/domains.json?api_token={api_token}
Arguments
Name | Parameter Type | Data type | Required/Optional | Description |
---|---|---|---|---|
api_token | query | string | Required | API token of the manager who perform the operation (see API Token Authentication) |
page | query | integer | Optional | Returning a list of domains by current page number |
per_page | query | integer | Optional | Setting a number of items in the page |
sorting[field] | query | string | Optional | Sorting the list by the specified field |
sorting[reversed] | query | string | Required | Set the reversed sorting mode by the specified field:
|
filters[created_at] | query | date | Optional | Filtering the list by a creation date |
filters[updated_at] | query | date | Optional | Filtering the list by an update date |
filters[account_id] | query | string | Optional | Filtering the list by an account ID |
filters[name] | query | string | Optional | Filtering the list by a domain name account ID |
Response model
Name | Data type | Description |
---|---|---|
id | integer | A domain ID |
account_id | integer | An account ID, to whom relates the domain |
name | string | A domain name |
records | array | A list of DNS records of the domain |
Request example
GET http://billing.activeplatform.com:80/api/vendor/v1/domains.json?api_token=654321
Response example
[
{
"id": 8,
"account_id": 2000036,
"name": "lynctest11.com",
"records": [
{
"name": "lynctest11.com.",
"type": "SOA",
"content": {
"primary": "ns1.systemdns.com",
"hostmaster": "john.doe@gmail.com",
"serial": "2014123002",
"refresh": "7200",
"retry": "2419200",
"expire": "3600",
"default_ttl": "3600"
},
"ttl": 3600,
"prio": null,
"raw_content": "123.123.123.123"
}
]
}
]