Domains (v2)

The base URL for this API is: https://api.leaseweb.com/hosting/v2

Errors

The API uses standard HTTP status codes to indicate the success or failure of the API call. The response will be JSON. Most APIs use the following format:

{
"errorCode" : "APP00800",
"errorMessage" : "The connection with the DB cannot be established.",
"correlationId" : "550e8400-e29b-41d4-a716-446655440000",
"userMessage" : "Cannot handle your request at the moment. Please try again later.",
"reference" : "http://developer.leaseweb.com/errors/APP00800"
}

Authentication

Authentication for the APIs is required. To authenticate your call, you will need to sent your API key as X-LSW-Auth header.

You can generate API keys in the Customer Portal.

Domains

List domains

Authorizations:

X-LSW-Auth

query Parameters

limit	integer Default: 10 Example: limit=10 Limit the number of results returned
offset	integer Default: 0 Return results starting from the given offset
type	string Enum: "dns" "email" "overview" Example: type=overview Supplement the domain listing with statistics about either DNS and Email

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2
Ruby + Native
Node + Native

curl --request GET \
  --url 'https://api.leaseweb.com/hosting/v2/domains?limit=SOME_INTEGER_VALUE&offset=SOME_INTEGER_VALUE&type=overview' \
  --header 'x-lsw-auth: REPLACE_KEY_VALUE'

Response samples

Content type

{"domains": [{"domainName": "example.com",
"suspended": true,
"dnsOnly": false,
"status": "SUSPENDED",
"contractStartDate": "2017-04-01T00:00:00+02:00",
"contractEndDate": "2018-04-01T00:00:00+02:00",
"_links": {"self": {"href": "/domains/example.com"
},
"collection": {"href": "/domains"
},
"catchAll": {"href": "/domains/example.com/catchAll"
},
"contacts": {"href": "/domains/example.com/contacts"
},
"nameservers": {"href": "/domains/example.com/nameservers"
},
"emailAliases": {"href": "/domains/example.com/emailAliases"
},
"forwards": {"href": "/domains/example.com/forwards"
},
"mailboxes": {"href": "/domains/example.com/mailboxes"
},
"resourceRecordSets": {"href": "/domains/example.com/resourceRecordSets"
},
"validateZone": {"href": "/domains/example.com/validateZone"
}
}
},
{"domainName": "example.org",
"suspended": false,
"dnsOnly": true,
"status": "ACTIVE",
"contractStartDate": "2015-01-01T00:00:00+00:00",
"_links": {"self": {"href": "/domains/example.org"
},
"collection": {"href": "/domains"
},
"catchAll": {"href": "/domains/example.org/catchAll"
},
"contacts": {"href": "/domains/example.com/contacts"
},
"nameservers": {"href": "/domains/example.com/nameservers"
},
"emailAliases": {"href": "/domains/example.org/emailAliases"
},
"forwards": {"href": "/domains/example.org/forwards"
},
"mailboxes": {"href": "/domains/example.org/mailboxes"
},
"resourceRecordSets": {"href": "/domains/example.org/resourceRecordSets"
},
"validateZone": {"href": "/domains/example.org/validateZone"
}
}
},
{"domainName": "example.nl",
"suspended": false,
"dnsOnly": false,
"status": "PENDING",
"contractStartDate": "2017-08-01T00:00:00+02:00",
"contractEndDate": "2019-08-01T00:00:00+02:00",
"_links": {"self": {"href": "/domains/example.nl"
},
"collection": {"href": "/domains"
},
"catchAll": {"href": "/domains/example.nl/catchAll"
},
"contacts": {"href": "/domains/example.com/contacts"
},
"nameservers": {"href": "/domains/example.com/nameservers"
},
"emailAliases": {"href": "/domains/example.nl/emailAliases"
},
"forwards": {"href": "/domains/example.nl/forwards"
},
"mailboxes": {"href": "/domains/example.nl/mailboxes"
},
"resourceRecordSets": {"href": "/domains/example.nl/resourceRecordSets"
},
"validateZone": {"href": "/domains/example.nl/validateZone"
}
}
},
{"domainName": "no-email-services-configured.com",
"suspended": true,
"dnsOnly": false,
"status": "SUSPENDED",
"contractStartDate": "2012-11-01T00:00:00+01:00",
"_links": {"self": {"href": "/domains/no-email-services-configured.com"
},
"collection": {"href": "/domains"
},
"catchAll": {"href": "/domains/no-email-services-configured.com/catchAll"
},
"contacts": {"href": "/domains/example.com/contacts"
},
"nameservers": {"href": "/domains/example.com/nameservers"
},
"emailAliases": {"href": "/domains/no-email-services-configured.com/emailAliases"
},
"forwards": {"href": "/domains/no-email-services-configured.com/forwards"
},
"mailboxes": {"href": "/domains/no-email-services-configured.com/mailboxes"
},
"resourceRecordSets": {"href": "/domains/no-email-services-configured.com/resourceRecordSets"
},
"validateZone": {"href": "/domains/no-email-services-configured.com/validateZone"
}
}
}
],
"_links": {"self": {"href": "/domains"
},
"dns": {"href": "/domains?type=dns"
},
"email": {"href": "/domains?type=email"
}
},
"_metadata": {"totalCount": 4,
"limit": 10,
"offset": 0
}
}

Inspect a domain

Authorizations:

X-LSW-Auth

path Parameters

domainName

required

string

Example: example.com

Domain name

Responses

Request samples

Shell + Curl
Python + Python3
Php + Http2