Function: sitebuilder

Result: the list of elements

Site builder

Access level: admin user

  • domain — Domain name
  • ip — IP address
  • username — Username
  • id — Id
  • pricelist — Tariff plan
  • account — Client
  • project — Provider
  • datacentername — Data center
  • processingmodule — Processing module
  • createdate — Creation date
  • expiredate — End date
  • autoprolong — Auto renewal
  • status_msg -
  • item_status -
  • cost — Price

Hard reboot of server in the control panel

Function: service.hardreboot

Hard reboot of server in the control panel

Access level: admin user

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of sitebuilder function.

Result: successful operation or error message

Drill down to User panel

Function: sitebuilder.su

Drill down to User panel

Access level: admin

Resume

Function: sitebuilder.resume

Resume

Access level: admin

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of sitebuilder function.

Result: successful operation or error message

Service usage statistics

Function: service.stat

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid — unique identifier (id element of sitebuilder function)
  • Result: object parameters list

Create an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • elid — unique identifier (id element of sitebuilder function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Submit a subject related to this service

Function: service.ask

Submit a subject related to this service

Access level: user

The service will be suspended, and will be charged as suspended services. You can later start the service

Function: service.stop

The service will be suspended, and will be charged as suspended services. You can later start the service

Access level: admin user

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of sitebuilder function.

Result: successful operation or error message

Domain name

Function: sitebuilder.domain

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid — unique identifier (id element of sitebuilder function)
  • Result: object parameters list

Create an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • elid — unique identifier (id element of sitebuilder function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • freedomain_name — Free domain name.
  • additional_domain — Additional domain name.
  • owndomain — Domain name.
  • ordereddomain — Domain name.

Reboot the server in the control panel

Function: service.reboot

Reboot the server in the control panel

Access level: admin user

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of sitebuilder function.

Result: successful operation or error message

Name

Function: service.detail

Result: the list of elements

Service configuration

Access level: admin+

  • id — Id
  • name — Name
  • addonlimit — Tariff plan includes
  • value — Add-ons
  • props — Price

Delete the selected entries

Function: service.detail.delete

Delete the selected entries

Access level: admin+

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the idkey element of service.detail function.

Result: successful operation or error message

Edit the selected resource

Function: service.detail.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • plid — parent list unique identifier (id element of sitebuilder function).
    • elid — unique identifier (idkey element of service.detail function)
  • Result: object parameters list

Create an object:

Parameters:

  • sok — the parameter must not be empty, generally "ok".
    • plid — parent list unique identifier (id element of sitebuilder function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • plid — parent list unique identifier (id element of sitebuilder function).
    • elid — unique identifier (idkey element of service.detail function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • name — Name. Enter the name to display in the interface and documents
  • pricelist_measure — Unit of measure. Select a unit of measure for add-on
  • manualvalue — Quantity. Quantity of allocated resource
  • intvalue — Add-ons. Additional order. Values from to
  • boolvalue — . (Optional parameter. To enable the option click "on".) Resource value
  • enumerationitem — Value. Select a resource value
  • no_check_addon — . (Optional parameter. To enable the option click "on".) The add-on's value was changed without verification
  • addonlimit — Tariff plan includes. Tariff plan includes
  • addonbool — . (Optional parameter. To enable the option click "on".) Value of the tariff plan's resource
  • addonenumerationitem — Tariff plan includes.
  • noexpense — . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed
  • reboot — . (Optional parameter. To enable the option click "on".) Reboot server to apply changes

Order a new service

Function: sitebuilder.order

Order a new service

Access level: user

IP address

Function: service.ip

Result: the list of elements

IP addresses

Access level: admin user

  • id — Id
  • name — IP address
  • mask — Mask
  • gateway — Gateway
  • domain — Domain
  • type — Type
  • ip_status — Status
  • ip_clientstatus — Status

Move IP address

Function: service.ip.move

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

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

Create an object:

Parameters:

  • sok — the parameter must not be empty, generally "ok".
    • plid — parent list unique identifier (id element of sitebuilder function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • plid — parent list unique identifier (id element of sitebuilder function).
    • elid — unique identifier (id element of service.ip function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • item — Service. Enter the service ID. This IP address will be moved to the selected service.
  • noexpense — . (Optional parameter. To enable the option click "on".) A client won't be charged for a new IP address
  • postpaid — . (Optional parameter. To enable the option click "on".) Select the check box to provide services on credit in case of insufficient funds on client's account

IP addresses

Function: service.ip.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

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

Create an object:

Parameters:

  • sok — the parameter must not be empty, generally "ok".
    • plid — parent list unique identifier (id element of sitebuilder function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • plid — parent list unique identifier (id element of sitebuilder function).
    • elid — unique identifier (id element of service.ip function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • type — Type of IP address. Type of IP address
  • pools — IP pool. Enter the pool that contains this IP address
  • domain — Domain. Reverse PTR for IP address
  • ippool — IP pool . Please specify the pool from which this IP is allocated
  • name — IP address. IP address
  • mask — Subnet mask . Enter a subnet mask. It will be used for network configuration by other products
  • gateway — Gateway . Enter a gateway address. Usually, this is the same address as the primary IP.
  • addinpanel — . (Optional parameter. To enable the option click "on".) Clear the check box if you don't want to add IP into the control panel
  • addinipmgr — . (Optional parameter. To enable the option click "on".) Clear the check box if you don't want this IP to be reserved in IPmanager
  • count — Number. Number of IP addresses you want to add . Values from 1 to 1000
  • noexpense — . (Optional parameter. To enable the option click "on".) A client won't be charged for a new IP address
  • postpaid — . (Optional parameter. To enable the option click "on".) Select the check box to provide services on credit in case of insufficient funds on client's account
  • reboot — . (Optional parameter. To enable the option click "on".) Reboot server to apply changes

Deleting IP-address

Function: service.ip.del.admin

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

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

Create an object:

Parameters:

  • sok — the parameter must not be empty, generally "ok".
    • plid — parent list unique identifier (id element of sitebuilder function).
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • plid — parent list unique identifier (id element of sitebuilder function).
    • elid — unique identifier (id element of service.ip function)
    • additional query parameters ...
  • Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

  • noexpense — . (Optional parameter. To enable the option click "on".) IP-address will be deleted without making refund to a client
  • manual — . (Optional parameter. To enable the option click "on".) IP-address will be deleted from billing only. Address availability in control panel or in IPmanager won't be checked
  • ipcount — Amount of addresses . Total amount of IP-addresses being deleted
  • cost — Refund amount. Total amount to be added to a client's account after deleting IP-addresses

Delete

Function: service.ip.delete

Delete

Access level: user

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of service.ip function.

Result: successful operation or error message

Name

Function: service.ip.history

Result: the list of elements

IP address change history

Access level: admin user

  • changedate — Change date
  • desc — Description
  • user — Username
  • ip — IP address
  • action — Function

Edit properties of the selected service

Function: sitebuilder.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid — unique identifier (id element of sitebuilder function)
  • Result: object parameters list

Create an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • elid — unique identifier (id element of sitebuilder function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule — Processing module. Processing module
  • autoprolong — Auto renewal. Select a period to automatically renew the service upon expiration
  • createdate — Order date . Date when the service was ordered
  • opendate — Creation date. Activation date
  • expiredate — Expiration date. Validity period
  • scheduledclose — . (Optional parameter. To enable the option click "on".) Service will be deleted after paid period
  • reboot — . (Optional parameter. To enable the option click "on".)
  • note — Comment. Enter any information related to the service. It will be displayed only to administrators
  • noexpense — . (Optional parameter. To enable the option click "on".) Select the check box if you don't want to charge/refund a client if his service resources have been changed

Suspend

Function: sitebuilder.suspend

Suspend

Access level: admin

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of sitebuilder function.

Result: successful operation or error message

Set a filter by the selected client

Function: sitebuilder.setfilter

Set a filter by the selected client

Access level: admin

Send a ticket to the selected client

Function: ticket.write.service

Send a ticket to the selected client

Access level: admin

Change password

Function: service.changepassword

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid — unique identifier (id element of sitebuilder function)
  • Result: object parameters list

Create an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • elid — unique identifier (id element of sitebuilder function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • passwd — . Enter a new password for the service
  • confirm — Re-enter password.

Setup and usage guide

Function: service.instruction.html

Setup and usage guide

Access level: admin user

Renew the selected service

Function: service.prolong

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid — unique identifier (id element of sitebuilder function)
  • Result: object parameters list

Create an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • elid — unique identifier (id element of sitebuilder function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • period — Period. Select a renewal period for this service

Delete the selected services

Function: sitebuilder.delete

Delete the selected services

Access level: admin user

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of sitebuilder function.

Result: successful operation or error message

The service will get activated, and the client will be charged as if he uses the active service

Function: service.start

The service will get activated, and the client will be charged as if he uses the active service

Access level: admin user

Parameters:

  • elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of sitebuilder function.

Result: successful operation or error message

Service activation

Function: sitebuilder.open

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

  • Parameters:
    • elid — unique identifier (id element of sitebuilder function)
  • Result: object parameters list

Create an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: successful operation or error message

Change an object:

  • Parameters:
    • sok — the parameter must not be empty, generally "ok".
    • elid — unique identifier (id element of sitebuilder function)
    • additional query parameters ...
  • Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

  • processingmodule — Processing module. Processing module for this service

Set filter.

sitebuilder.filter

Change the selected tariff plan

Function: service.changepricelist

Change the selected tariff plan

Access level: admin

Parameters:

  • elid — license id
  • pricelist — tariff id
  • su — administrator login

Name

Function: service.history

Result: the list of elements

Service history

Access level: admin user

  • changedate — Change date
  • desc — Change
  • user — Username
  • ip — IP address
  • action — Function