APIDocumentation

Deutsch | English | Español

Currency:

EUR

Your country is:

Choose your country!

2.13. Hosting
Prev	Chapter 2. Methods	Next

2.13. Hosting

The hosting object provides methods to manage the hosting package.

2.13.1. hosting.cancel

Cancel a hosting package.

2.13.1.1. Input

Table 2.173. Parameters

Parameter	Description	Type	Required	Default
hostingId	Hosting package id	token255	true

2.13.1.2. Output

No additional return parameters

2.13.2. hosting.controlPanel

Returns the url to the control panel.

2.13.2.1. Input

Table 2.174. Parameters

Parameter	Description	Type	Required	Default
id	Hosting package id	int	true
userAgent	User agent of the client browser	token0255	true

2.13.2.2. Output

Table 2.175. Parameters

Parameter	Description	Type	Optional
url	Url to the hosting control panel	token255
ip	Ip address of the client	ip

2.13.3. hosting.create

Order a hosting package.

2.13.3.1. Input

Table 2.176. Parameters

Parameter	Description	Type	Required	Default
hostingId	Hosting package id	token255	false
productId	Hosting package id	token255	false
testing	Execute command in testing mode	boolean	false	false

2.13.3.2. Output

No additional return parameters

2.13.4. hosting.getPrices

Get hosting packages prices.

2.13.4.1. Input

No parameters allowed

2.13.4.2. Output

Table 2.177. Parameters

Parameter	Description	Type	Optional
hosting
... id	Id of the hosting package	int	Yes
... product	Name of the hosting package product	int	Yes

2.13.5. hosting.issuspended

Check whether a hosting plan is currently suspended

2.13.5.1. Input

Table 2.178. Parameters

Parameter	Description	Type	Required	Default
hostingId	ID of the hosting product	int	true

2.13.5.2. Output

Table 2.179. Parameters

Parameter	Description	Type
isSuspended	Indicates whether the specified hosting plan is currently suspended	boolean
endDate	Cancellation time of the specified hosting plan	dateTime
paidUntil	Paid until information for the hosting product	dateTime

2.13.6. hosting.list

Lists customers hosting packages.

2.13.6.1. Input

No parameters allowed

2.13.6.2. Output

Table 2.180. Parameters

Parameter	Description	Type	Optional
count	Total number of hosting packages	int
hosting
... id	Id of the hosting package	int	Yes
... product	Name of the hosting package product	int	Yes

2.13.7. hosting.reinstate

Reinstate a hosting package.

2.13.7.1. Input

Table 2.181. Parameters

Parameter	Description	Type	Required	Default
hostingId	Hosting package id	token255	true

2.13.7.2. Output

No additional return parameters

2.13.8. hosting.unsuspend

Unsuspend a suspend hosting product of a customer

2.13.8.1. Input

Table 2.182. Parameters

Parameter	Description	Type	Required	Default
hostingId	ID of the hosting product	int	true
testing	Execute order in testing mode (no order will be submitted)	boolean	false	false

2.13.8.2. Output

Table 2.183. Parameters

Parameter	Description	Type
netPrice	Net price for restoring and extending hosting plan	float
grossPrice	Gross price for restoring and extending hosting plan	float
currency	Currency of paid price	text255
quantity	Quantity	int
unit	Unit (months or years)	text255
message	System message	text255