pem.brandDomain
This method is supported by Operations starting from version 2.6.
This method creates a Brand on the existing Domain.
The method has the following input parameters:
Name |
Type |
Short Description |
---|---|---|
|
string |
Name of the existing domain with Apache server hosting to create branding for. |
|
int |
Subscription ID. This parameter defines the Subscription, which contains the Resource Type created on the basis of the Branding access points Resource Class. It is optional parameter. If parameter is not specified, the required Subscription is chosen by Operations. |
|
string |
Name of the brand to be created. If not issued, brand name will be the same as the name of the domain. |
|
string |
This prefix will be added to the branded URL path. For example, http://mydomain.com/path_prefix/. If not issued, no prefix will be added. |
|
string |
The URL of the logo to be inserted to the control panel. If not issued, the default logo will be used. |
|
string |
Name of the skin to be installed to control panels. If not issued, the default skin will be used. |
|
string |
Access type to the branded domain. There are the following options: s – stands for SSL access h – non-SSL b – will provide both access types |
|
base 64 |
Binary logo image data. If |
|
string |
Type of the brand's IP address. Can be ' |
|
string |
SSL certificate to be added to the brand domain. If this parameter is passed, the key parameter should be also specified. If this parameter is omitted, a self-signed SSL certificated will be issued and added to the domain of this brand. |
|
string |
Private key for the SSL certificate. |
Note: Starting from Operations 2.9, method creates Brand with SSL access type only and the access_type
parameter is deprecated (parameter is ignored, if it is passed).
The method returns the following parameter:
Name |
Type |
Short Description |
---|---|---|
|
int |
ID of created brand. |