GET api/Hosting?user={user}
Return a list of hosting objects for the supplied user
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| user |
Owner of object(s). If empty, currently logged in user will be used |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
A list of hosting objects on success
Collection of errors on failure
Return codes
200 - ok
401 - unauthorized
404 - not found
500 - internal server error
| Name | Description | Type | Additional information |
|---|---|---|---|
| HostingHandle |
Object handle |
string |
None. |
| DomainHandle |
Domain object handle |
string |
None. |
| Dir |
Mail Object handle |
string |
None. |
| PackId | integer |
None. |
|
| HasStats | boolean |
None. |
|
| HasLogs | boolean |
None. |
|
| FreqLogs | integer |
None. |
|
| IsFp | boolean |
None. |
|
| FlagFp | integer |
None. |
|
| GroupServerId | integer |
None. |
|
| HostingEtat | integer |
None. |
|
| IsDemo | boolean |
None. |
|
| HasWordPressOneClick | boolean |
None. |
|
| HostingName |
Name of hosting instance |
string |
None. |
| PackName |
Name of the hosting pack |
string |
None. |
| DomainName |
Domaine associated with this domaine |
string |
None. |
| AdminContact |
Admin contact |
HostingContact |
None. |
| BillingContact |
Billing contact |
HostingContact |
None. |
| RegDate |
Date registered |
date |
None. |
| ObjectHandle | string |
None. |
|
| CreDate |
Date created |
date |
None. |
| ExpDate |
Expiry date |
date |
None. |
| TransferInDate |
Transfer in date |
date |
None. |
| Os |
Operating system - linux, windows |
string |
None. |
| OsVersion |
Operating system version |
string |
None. |
| PublicIp |
Public ip address of the server |
string |
None. |
| FrameWork |
Framework |
Framework |
None. |
| PackType | string |
None. |
|
| Detail | string |
None. |
|
| WindowsConfig |
Windows configuration |
WindowsConfig |
None. |
| Limits |
Allowed limits |
Limits |
None. |
| AutoRenew |
Has auto renew |
boolean |
None. |
| Status |
Object status |
string |
None. |
Response Formats
application/json, text/json
[
{
"HostingHandle": "myhost1",
"DomainHandle": "mydom1",
"Dir": "/var/www/sites/myhost1",
"PackId": 0,
"HasStats": false,
"HasLogs": false,
"FreqLogs": 0,
"IsFp": false,
"FlagFp": 0,
"GroupServerId": 0,
"HostingEtat": 0,
"IsDemo": false,
"HasWordPressOneClick": false,
"HostingName": "mydomain.com",
"PackName": "Linux 5",
"DomainName": "mydomain.com",
"AdminContact": null,
"BillingContact": null,
"RegDate": "0001-01-01T00:00:00",
"ObjectHandle": null,
"CreDate": "0001-01-01T00:00:00",
"ExpDate": "0001-01-01T00:00:00",
"TransferInDate": "0001-01-01T00:00:00",
"Os": "linux",
"OsVersion": null,
"PublicIp": null,
"FrameWork": {
"Id": null,
"Type": "PHP",
"Version": "7.1.12",
"Desrciption": "PHP 7.1.12",
"Os": "linux",
"Default": false,
"Actif": false
},
"PackType": "linux",
"Detail": null,
"WindowsConfig": null,
"Limits": null,
"AutoRenew": null,
"Status": null
}
]
application/xml, text/xml
<ArrayOfHosting xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Hosting">
<Hosting>
<AdminContact i:nil="true" />
<AutoRenew i:nil="true" />
<BillingContact i:nil="true" />
<CreDate>0001-01-01T00:00:00</CreDate>
<Detail i:nil="true" />
<Dir>/var/www/sites/myhost1</Dir>
<DomainHandle>mydom1</DomainHandle>
<DomainName>mydomain.com</DomainName>
<ExpDate>0001-01-01T00:00:00</ExpDate>
<FlagFp>0</FlagFp>
<FrameWork>
<Actif>false</Actif>
<Default>false</Default>
<Desrciption>PHP 7.1.12</Desrciption>
<Id i:nil="true" />
<Os>linux</Os>
<Type>PHP</Type>
<Version>7.1.12</Version>
</FrameWork>
<FreqLogs>0</FreqLogs>
<GroupServerId>0</GroupServerId>
<HasLogs>false</HasLogs>
<HasStats>false</HasStats>
<HasWordPressOneClick>false</HasWordPressOneClick>
<HostingEtat>0</HostingEtat>
<HostingHandle>myhost1</HostingHandle>
<HostingName>mydomain.com</HostingName>
<IsDemo>false</IsDemo>
<IsFp>false</IsFp>
<Limits i:nil="true" />
<ObjectHandle i:nil="true" />
<Os>linux</Os>
<OsVersion i:nil="true" />
<PackId>0</PackId>
<PackName>Linux 5</PackName>
<PackType>linux</PackType>
<PublicIp i:nil="true" />
<RegDate>0001-01-01T00:00:00</RegDate>
<Status i:nil="true" />
<TransferInDate>0001-01-01T00:00:00</TransferInDate>
<WindowsConfig i:nil="true" />
</Hosting>
</ArrayOfHosting>