Returns a list of domains. This list can be filtered with optional arguments.
https://backoffice.hostcontrol.com/api/v1/domain
Parameter | Required? | Description | Example value |
---|---|---|---|
customer | optional | Id of a customer. Returns domains only belonging to this customer. | 5 |
expiring | optional | If supplied, returns only expiring domains. This uses the renew interval setting (in days). | true |
GET https://backoffice.hostcontrol.com/api/v1/domain?customer=4&expiring=true
Result
{
"result": [
{
"status": "delivered",
"updated": "2013-10-17T13:00:40.339362+00:00",
"managed": true,
"deleted": null,
"expires": "2014-10-17T13:00:40.338549+00:00",
"is_customer_manageable": true,
"customer": {
"is_enabled": true,
"updated": "2013-10-17T12:55:28.760871+00:00",
"is_dns_management_enabled": true,
"created": "2013-10-17T12:55:28.760831+00:00",
"primary_contact": {
"city": "Zwolle",
"fax": "",
"voice": "+31.384530752",
"updated": "2013-10-17T12:55:28.766026+00:00",
"name": "Demo Customer",
"created": "2013-10-17T12:55:28.765999+00:00",
"gender": "male",
"organisation": "",
"extra": {},
"zipcode": "8024 AA",
"email": "customer@resello.com",
"state": "Gelderland",
"address": "Ceintuurbaan 28",
"domains": [
"fsdsdf.net"
],
"vat_number": null,
"country": {
"code": "NL",
"name": "Netherlands"
},
"type": "primary",
"id": 36
},
"is_receiving_support_notifications": true,
"is_ns_management_enabled": true,
"is_verified": true,
"id": 25
},
"name": "fsdsdf.net",
"redirects": [],
"created": "2013-10-17T13:00:40.339314+00:00",
"is_privacy_protect_enabled": false,
"interval": 12,
"hosting": {
"status": "delivered",
"updated": "2013-10-17T13:00:47.164939+00:00",
"reference": "ac-j124h",
"deleted": null,
"expires": "2014-10-17T13:00:47.164055+00:00",
"is_active": true,
"plan": {
"category": "InstantWeb",
"traffic_quota": null,
"is_installations_enabled": false,
"name": "Web 10",
"is_pop3_enabled": true,
"storage_quota": 5120,
"max_database_count": 0,
"max_domain_count": 1,
"max_mailbox_count": null,
"prices": [
{
"price_new": 5067.48,
"price_renew": 10875.48,
"interval": 12,
"currency": "USD"
}
],
"is_smtp_enabled": true,
"is_imap_enabled": true,
"max_mailbox_alias_count": null,
"instasite_plan": 4,
"is_webpresence_enabled": false,
"max_user_count": 0,
"type": "instasite",
"id": 62,
"max_mailbox_size": 2048
},
"customer": {
"is_enabled": true,
"updated": "2013-10-17T12:55:28.760871+00:00",
"is_dns_management_enabled": true,
"created": "2013-10-17T12:55:28.760831+00:00",
"primary_contact": {
"city": "Zwolle",
"fax": "",
"voice": "+31.384530752",
"updated": "2013-10-17T12:55:28.766026+00:00",
"name": "Demo Customer",
"created": "2013-10-17T12:55:28.765999+00:00",
"gender": "male",
"organisation": "",
"extra": {},
"zipcode": "8024 AA",
"email": "customer@resello.com",
"state": "Gelderland",
"address": "Ceintuurbaan 28",
"domains": [
"fsdsdf.net"
],
"vat_number": null,
"country": {
"code": "NL",
"name": "Netherlands"
},
"type": "primary",
"id": 36
},
"is_receiving_support_notifications": true,
"is_ns_management_enabled": true,
"is_verified": true,
"id": 25
},
"created": "2013-10-17T13:00:47.164891+00:00",
"interval": 12,
"renew": true,
"domains": [
"fsdsdf.net"
]
},
"renew": true,
"tld": {
"name": "net"
}
},
{
"status": "delivered",
"updated": "2013-10-15T12:38:49.945448+00:00",
"managed": false,
"deleted": null,
"expires": "2014-10-15T12:38:49.926324+00:00",
"is_customer_manageable": true,
"customer": {
"is_enabled": true,
"updated": "2013-10-16T08:27:06.226324+00:00",
"is_dns_management_enabled": true,
"created": "2013-10-15T08:32:29.484444+00:00",
"primary_contact": {
"city": "Zwolle",
"fax": "",
"voice": "+31.654878787",
"updated": "2013-10-15T08:32:29.490809+00:00",
"name": "Ik Ben Een Klant",
"created": "2013-10-15T08:32:29.490782+00:00",
"gender": "male",
"organisation": "",
"extra": {},
"zipcode": "8042LK",
"email": "ik-ben-een-klant@klantbedrijf.nl",
"state": "Overijssel",
"address": "Tuurceinbaan 82\\n",
"domains": [
"sadfsadfsdaf.com",
"testresello.com",
"sadfsadfsdfasd.net",
"mijnmooieresellotest.com",
"sadfsadfdsaf.nl"
],
"vat_number": null,
"country": {
"code": "NL",
"name": "Netherlands"
},
"type": "primary",
"id": 20
},
"is_receiving_support_notifications": true,
"is_ns_management_enabled": true,
"is_verified": true,
"id": 17
},
"name": "testresello.com",
"redirects": [],
"created": "2013-10-15T12:38:49.944457+00:00",
"is_privacy_protect_enabled": false,
"interval": 12,
"hosting": null,
"renew": true,
"tld": {
"name": "com"
}
}
],
"success": true
}