Site builder (sitebuilder)

sitebuilder

Result: list of items

Website builder

Access level: admin user

Parameter	Value
`domain`	Domain name.
`ip`	IP address.
`username`	Username.
`id`	ID.
`pricelist`	Tariff.
`account`	Client.
`project`	Provider.
`datacentername`	Data center.
`processingmodule`	Processing module.
`createdate`	Creation date.
`expiredate`	Expires on.
`autoprolong`	Auto-renewal.
`status_msg`	Current status description.
`item_status`	Service status. Possible values: 1 — ordered; 2 — active; 3 — suspended; 4 — deleted; 5 — processing
`cost`	Cost.

Force server reboot in control panel

Function: service.hardreboot

Force server reboot in control panel.

Access level: admin user

Parameters:

elid — one or more unique object identifiers separated by comma and space ", ". The unique identifier is the id element from the sitebuilder function.

Result: successful operation or error message.

Log in to panel with user privileges

Function: sitebuilder.su

Access level: admin

Resume

Function: sitebuilder.resume

Resume.

Access level: admin

Parameters:

elid — one or more unique object identifiers separated by comma and space ", ". The unique identifier is the id element from the sitebuilder function.

Result: successful operation or error message.

Resource usage statistics

Function: service.stat

Access level: admin user

Used to view object parameters, modify objects, and create new objects.

View object parameters:

Parameters:
- elid — unique identifier (id element from the sitebuilder function);
Result: list of object parameters.

Create object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
Result: successful operation or error message.

Modify object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- elid — unique identifier (id element from the sitebuilder function);
Result: successful operation or error message.

Ask a question about the service

Function: service.ask

Ask a question about the service

Access level: user

Suspend service

Function: service.stop

The service will enter a suspended state; billing will follow rules for suspended services. You can later resume the service yourself.

Access level: admin user

Parameters:

elid — one or more unique object identifiers separated by comma and space ", ". The unique identifier is the id element from the sitebuilder function.

Result: successful operation or error message.

Service domain name

Function: sitebuilder.domain

Access level: admin user

Used to view object parameters, modify objects, and create new objects.

View object parameters:

Parameters:
- elid — unique identifier (id element from the sitebuilder function).
Result: list of object parameters.

Create object:

Parameters:
- sok — parameter value must be non-empty, usually ok.
Result: successful operation or error message.

Modify object:

Parameters:
- sok — parameter value must be non-empty, usually ok.
- elid — unique identifier (id element from the sitebuilder function).
Result: successful operation or error message.

List of object parameters or additional request parameters:

Parameter	Value
`freedomain_name`	Free domain name.
`additional_domain`	Additional domain name.
`owndomain`	Domain name.
`ordereddomain`	Domain name.

Server reboot in control panel

Function: service.reboot

Server reboot in control panel.

Access level: admin user

Parameters:

elid — one or more unique object identifiers separated by comma and space ", ". The unique identifier is the id element from the sitebuilder function.

Result: successful operation or error message.

Service configuration

Function: service.detail

Result: list of items.

Service configuration.

Access level: admin+

Parameter	Value
`id`	ID.
`name`	Name.
`addonlimit`	Included in tariff.
`value`	Ordered additionally.
`props`	Cost.

Delete selected records

Function: service.detail.delete

Delete selected records.

Access level: admin+

Parameters:

elid — one or more unique object identifiers separated by comma and space ", ". The unique identifier is the idkey element from the service.detail function.

Result: successful operation or error message.

Edit resource

Function: service.detail.edit

Access level: admin+

Used to view object parameters, modify objects, and create new objects. View object parameters:

Parameter	Value
`plid`	Unique parent list identifier (`id` element from the `sitebuilder` function).
`elid`	Unique identifier (`idkey` element from the `service.detail` function).
`sok`	Parameter value must be non-empty, usually `ok`.
`name`	Name. Specify the resource name to be displayed in the interface and documents.
`pricelist_measure`	Add-on unit of measure.
`manualvalue`	Amount of resource provided.
`intvalue`	Ordered additionally. Values from to.
`boolvalue`	Resource value. To enable the option, use the value `on`. Optional parameter.
`enumerationitem`	Value. Select the resource value.
`no_check_addon`	The add-on value will be changed without validation by the processing module. To enable the option, use the value `on`. Optional parameter.
`addonlimit`	Included in tariff.
`addonbool`	Resource value provided by the tariff plan. To enable the option, use the value `on`. Optional parameter.
`addonenumerationitem`	Included in tariff.
`noexpense`	Select this option if no funds should be charged or refunded for the current resource modification operation. To enable the option, use the value `on`. Optional parameter.
`reboot`	Reboot server after applying parameters. To enable the option, use the value `on`. Optional parameter.

Order new service

Function: sitebuilder.order

Order new service

Access level: user

IP address

Function: service.ip

Result: list of items.

IP addresses.

Access level: admin user

Parameter	Value
`id`	ID.
`name`	IP address.
`mask`	Mask.
`gateway`	Gateway.
`domain`	Domain.
`type`	Type.
`ip_status`	Status.
`ip_clientstatus`	Client status.

Check IP address status

Function: service.ip.checkadd

Access level: admin user

Checks the status of an assigned IP address from the integrated platform. If the IP address is already in use by another service, the platform selects a different IP address.

Parameters:
- ip — IP address to check. Both IPv4 and IPv6 are allowed;
- item — service ID for which to verify the ability to use the specified IP address.
Result:
- if the specified IP address is occupied by a service other than the one passed in the item parameter, the function returns the flag ip_on_active_item=on ;
- if the specified IP address is free or occupied by the same service as specified in the item parameter, the flag is not returned.

Transfer IP address

Function: service.ip.move

Access level: admin user

Used to view object parameters, modify objects, and create new objects. View object parameters:

Parameters:
- plid — unique parent list identifier (id element from the sitebuilder function);
- elid — unique identifier (id element from the service.ip function);
Result: list of object parameters.

Create object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique parent list identifier (id element from the sitebuilder function);
Result: successful operation or error message.

Modify object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique parent list identifier (id element from the sitebuilder function);
- elid — unique identifier (id element from the service.ip function);
Result: successful operation or error message.

List of object parameters or additional request parameters:

item — Service ID to which the IP address is being transferred;
noexpense — IP address will be added without charging the client's account. To enable the option, use the value on. Optional parameter;
postpaid — If enabled, expenses will be created on credit when the account balance is insufficient. To enable the option, use the value on. Optional parameter.

IP address

Function: service.ip.edit

Access level: admin user

Used to view object parameters, modify objects, and create new objects.

View object parameters:

Parameters:
- plid — unique parent list identifier (id element from the sitebuilder function);
- elid — unique identifier (id element from the service.ip function);
Result: list of object parameters.

Create object:

Parameters:
- sok — parameter value must be non-empty, usually ok.
- plid — unique parent list identifier (id element from the sitebuilder function);
Result: successful operation or error message.

Modify object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique parent list identifier (id element from the sitebuilder function);
- elid — unique identifier (id element from the service.ip function);
Result: successful operation or error message.

List of object parameters or additional request parameters:

Parameter	Value
`type`	Type of IP address being added.
`pools`	IP pool. Specify the pool containing this IP address.
`domain`	Domain. Reverse PTR record for the IP address.
`ippool`	IP pool. Specify the pool containing this IP address.
`name`	IP address.
`mask`	Subnet mask, used by other products for network configuration.
`gateway`	Gateway address, used by other products for network configuration.
`addinpanel`	Disable this option if you don't want to add the address to the control panel. To enable the option, use the value `on`. Optional parameter.
`addinipmgr`	Disable this option if you don't want to reserve the IP address in IPmanager. To enable the option, use the value `on`. Optional parameter.
`count`	Number of addresses to create. Values from 1 to 1000.
`noexpense`	IP address will be added without charging the client's account. To enable the option, use the value `on`. Optional parameter.
`postpaid`	If enabled, expenses will be created on credit when the account balance is insufficient. To enable the option, use the value `on`. Optional parameter.
`reboot`	Reboot server after applying parameters. To enable the option, use the value `on`. Optional parameter.

Delete IP address

Function: service.ip.del.admin

Access level: admin+

Used to view object parameters, modify objects, and create new objects. View object parameters:

Parameters:
- plid — unique parent list identifier (id element from the sitebuilder function);
- elid — unique identifier (id element from the service.ip function);
Result: list of object parameters

Create object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique parent list identifier (id element from the sitebuilder function);
Result: successful operation or error message.

Modify object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- plid — unique parent list identifier (id element from the sitebuilder function);
- elid — unique identifier (id element from the service.ip function);
Result: successful operation or error message.

List of object parameters or additional request parameters:

Parameter	Value
`noexpense`	IP address will be deleted without refunding funds to the client's account. To enable the option, use the value `on`. Optional parameter.
`manual`	The address will be removed from billing only. Presence in the control panel and IPmanager is not verified. To enable the option, use the value `on`. Optional parameter.
`ipcount`	Total number of IP addresses being deleted.
`cost`	Refund amount to be credited to the client's account after IP address deletion.

Delete

Function: service.ip.delete

Delete

Access level: user

Parameters:

elid — one or more unique object identifiers separated by comma and space ", ". The unique identifier is the id element from the service.ip function

Result: successful operation or error message.

IP address history

Function: service.ip.history

Result: list of items.

IP address history.

Access level: admin user

Parameter	Value
`changedate`	Change date.
`desc`	Description.
`user`	Username.
`ip`	IP address.
`action`	Function.

Edit service

Function: sitebuilder.edit

Access level: admin user

Used to view object parameters, modify objects, and create new objects.

View object parameters:

Parameters:
- elid — unique identifier (id element from the sitebuilder function).
Result: list of object parameters.

Create object:

Parameters:
- sok — parameter value must be non-empty, usually ok.
Result: successful operation or error message.

Modify object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- elid — unique identifier (id element from the sitebuilder function);
Result: successful operation or error message.

List of object parameters or additional request parameters:

Parameter	Value
`processingmodule`	Processing module
`autoprolong`	Automatic renewal. Select the period for which the service will be automatically renewed upon expiration.
`createdate`	Service order date.
`opendate`	Actual service start date.
`expiredate`	Expires on. Service validity period.
`scheduledclose`	Scheduled deletion at the end of the paid period. To enable the option, use the value `on`. Optional parameter.
`reboot`	Reboot. To enable the option, use the value `on`. Optional parameter.
`note`	Service comment. Visible only to provider staff.
`noexpense`	Select this option if no funds should be charged or refunded for the current resource modification operation. To enable the option, use the value `on`. Optional parameter.

Disable website builder

Function: sitebuilder.suspend

Disable website builder.

Access level: admin

Parameters:

elid — one or more unique object identifiers separated by comma and space ", ". The unique identifier is the id element from the sitebuilder function.

Result: successful operation or error message.

Set client filter

Function: sitebuilder.setfilter

Set client filter.

Access level: admin

Write request to client

Function: ticket.write.service

Write request to client.

Access level: admin

Password change

Function: service.changepassword

Access level: admin user

Used to view object parameters, modify objects, and create new objects.

View object parameters:

Parameters:
- elid — unique identifier (id element from the sitebuilder function);
Result: list of object parameters

Create object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
Result: successful operation or error message.

Modify object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- elid — unique identifier (id element from the sitebuilder function);
Result: successful operation or error message.

List of object parameters or additional request parameters:

passwd — new service password;
confirm — confirmation.

Service usage instructions

Function: service.instruction.html

Service usage instructions.

Access level: admin user

Service renewal

Function: service.prolong

Access level: admin user

Used to view object parameters, modify objects, and create new objects.

View object parameters:

Parameters:
- elid — unique identifier (id element from the sitebuilder function).
Result: list of object parameters

Create object:

Parameters:
- sok — parameter value must be non-empty, usually ok.
Result: successful operation or error message.

Modify object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- elid — unique identifier (id element from the sitebuilder function).
Result: successful operation or error message.

List of object parameters or additional request parameters:

period — Period. Select the period for which the service needs to be renewed.

Delete selected services

Function: sitebuilder.delete

Delete selected services.

Access level: admin user

Parameters:

elid — one or more unique object identifiers separated by comma and space ", ". The unique identifier is the id element from the sitebuilder function.

Result: successful operation or error message.

Start service

Function: service.start

The service will enter an active state; billing will follow rules for active services.

Access level: admin user

Parameters:

elid — one or more unique object identifiers separated by comma and space ", ". The unique identifier is the id element from the sitebuilder function.

Result: successful operation or error message.

Open service

Function: sitebuilder.open

Access level: admin

Used to view object parameters, modify objects, and create new objects.

View object parameters:

Parameters:
- elid — unique identifier (id element from the sitebuilder function);
Result: list of object parameters.

Create object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
Result: successful operation or error message.

Modify object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- elid — unique identifier (id element from the sitebuilder function);
Result: successful operation or error message.

List of object parameters or additional request parameters:

processingmodule — Processing module assigned to the service.

Set filter

Function: sitebuilder.filter

Change tariff

Function: service.changepricelist

Change tariff.

Access level: admin

Parameters:

elid — license ID;
pricelist — tariff ID;
su — administrator login.

Service change history

Function: service.history

Result: list of items.

Service change history.

Access level: admin user

Parameter	Value
`changedate`	Change date.
`desc`	Change description.
`user`	Username.
`ip`	IP address.
`action`	Function.