Processing modules (processing)

Service processing modules (processing)

Function: processing

Result: list of items

Service processing modules

Access level: admin

UI Equivalent: go to Integration → Processing modules.

Allows managing service processing modules — components that ensure platform interaction with external control panels, service providers, or automation scripts.

Display list of service processing modules

Function: processing.show

Result: list of items

UI Equivalent: go to Integration → Processing modules.

Supports filtering, sorting, and pagination.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	No	`id` of the module for list filtering.
`name`	String	No	Search by name. Supports the wildcard character `*`.
`module`	String (enumeration)	No	Filter by processing module type. Allowed values: `pmmanual` — manual processing; `pmauto` — no processing; `pmispmgr6` — ISPmanager 6; `pmvmmgr6` — VMmanager 6; `pmdcimgr6` — DCImanager 6; and others.
`status`	Flag	No	Filter by status: `on` — enabled, `off` — disabled.
`datacenter`	Positive integer	No	Filter by data center identifier.
`sort`	String	No	Column name for sorting: `name`, `module`, `status`, `orderpriority`.
`pagesize`	Positive integer	No	Number of records per result page.
`startidx`	Non-negative integer	No	Offset of the first record for pagination.

Create a processing module

Function: processing.add

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Create.

Launches the wizard for creating a new processing module. The first step is selecting the product type.

Access level: admin

Parameter	Type	Required	Value
`type`	String (enumeration)	Yes	Product type for binding the processing module. For example: `colocation` — server colocation; `vdc` — virtual data center; `dnshost` — DNS hosting; `certificate` — SSL certificate; `addition` — ISPsystem modules; `soft` — licenses; `vhost` — virtual hosting; `vds` — VPS; `paas` — PaaS platform services; `backupservice` — backup; `game_server` — game server; `s3storage` — external S3 storage; and others.
`module`	String (enumeration)	Yes	Processing module. Allowed values: `pmmanual` — manual processing; `pmauto` — no processing; `pmispmgr4` — ISPmanager 4; `pmispmgr5` — ISPmanager 5; `pmispmgr6` — ISPmanager 6; `pmvmmgr` — VMmanager; `pmvmmgr6` — VMmanager 6; `pmdcimgr` — DCImanager; `pmdcimgr6` — DCImanager 6; `pmvdsmgr` — VDSmanager; `pmbillmgr` — BILLmanager; `pmnic` — RU-CENTER; `pmregru` — REG.RU; `pmwebnames` — WebNames; `pmthesslstore` — The SSL Store; `pmopenstack` — OpenStack; `pmvmware` — VMware; `pmshellscripts` — Shell scripts; `pmipmgr` — IPmanager; `pmcephradosgw` — Ceph S3; `pmpterodactyl` — Pterodactyl; `pmddosguard` — DDoS-GUARD; and others.

View module parameters

Function: processing.preview

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click View.

Returns detailed data of the processing module, including general information, settings, dependencies (tariffs, tasks, parameters, notifications, cluster nodes).

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the processing module.

Edit a processing module

Function: processing.edit

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click View → click Edit.

Used to view and modify module parameters.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	No	`id` of the processing module to edit. If not specified, a new one will be created.
`datacenter`	Positive integer	No	Data center identifier.
`name`	String	Yes	Arbitrary name of the processing module for display in the interface.
`department`	Positive integer	No	Responsible department to which tasks will be assigned if necessary.
`orderpriority`	Positive integer	No	Processing module priority.
`no_postprolong_task`	Flag	No	Do not create a renewal task. If the option is active, service renewal will proceed without platform administrator involvement: the current operation will not be transferred to manual processing; a task will not be created.
`userecipe`	Flag	No	Use recipes. If the option is active, a recipe can be specified when ordering a service.
`openmode`	String (enumeration)	No	Method of waiting for server installation completion. Allowed values: `openmode_wait_ostempl` — upon OS template installation completion; `openmode_wait_recipe` — upon recipe installation completion.
`licserverprovider`	Flag	No	Use provider's server.
`licserver`	Positive integer	No	License server identifier.
`sok`	String	Yes	The value `ok` confirms saving changes.

Delete a processing module

Function: processing.delete

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Delete.

Deletes the selected processing module. Supports deletion of multiple modules separated by commas.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	Yes	One or more module `id` values separated by commas. For example, `123,456`.
`sok`	String	Yes	The value `ok` confirms the operation.

Enable a processing module

Function: processing.resume

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Enable.

Activates selected processing modules. Confirmation via the sok parameter is required.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	Yes	One or more module `id` values separated by commas.
`sok`	String	Yes	The value `ok` confirms the operation.

Disable a processing module

Function: processing.suspend

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Disable.

Deactivates selected processing modules. New services will not be assigned to disabled modules.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	Yes	One or more module `id` values separated by commas.
`sok`	String	Yes	The value `ok` confirms the operation.

Move module one position up

Function: processing.up

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Up.

Changes the processing module priority in the list. The module will be displayed earlier in the processing module chain.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the module to move.
`sok`	String	Yes	The value `ok` confirms the operation.

Move module one position down

Function: processing.down

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Down.

Changes the processing module priority. The module will be displayed later in the processing module chain.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the module to move.
`sok`	String	Yes	The value `ok` confirms the operation.

Update module configuration

Function: processing.updateconfig

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Config.

Reloads the processing module configuration. Confirmation via the sok parameter is required.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the module to update configuration.
`sok`	String	Yes	The value `ok` confirms the operation.

Set a filter

Function: processing.filter

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → menu Filter.

Filter conditions are saved and applied to all subsequent processing.show calls until the filter is changed or reset.

Access level: admin

Parameter	Type	Required	Value
`name`	String	No	Filter value by name. Supports the wildcard character `*`.
`module`	String (enumeration)	No	Filter by processing module type.
`status`	Flag	No	Filter by status: `on` / `off`.
`reset`	Flag	No	The value `on` resets all set filters.

Go to module control panel

Function: processing.gotomoduleserver

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Open.

Returns a link to navigate to the context of the control panel or external service associated with the processing module.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the processing module for which the navigation link needs to be obtained.

Tariffs of processing modules

Display tariffs processed by the module

Function: processing.pricelist

Result: list of items

UI Equivalent: go to Integration → Processing modules → click Tariff plans.

Returns a list of pricing plans linked to the specified processing module. Supports filtering and sorting.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the processing module.
`name`	String	No	Search by tariff name. Supports the wildcard character `*`.
`status`	Flag	No	Flag indicating processing module activity for the pricing plan. Allowed values: `on` — used for processing new services; `off` — disabled.
`sort`	String	No	Column name for sorting: `name`, `status`.
`pagesize`	Positive integer	No	Number of records per result page.
`startidx`	Non-negative integer	No	Offset of the first record for pagination.

Enable processing for a tariff

Function: processing.pricelist.resume

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Tariffs → click Enable.

Activates processing of new services for selected tariffs.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	Yes	One or more tariff `id` values separated by commas.
`sok`	String	Yes	The value `ok` confirms the operation.

Disable processing for a tariff

Function: processing.pricelist.suspend

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Tariffs → click Disable.

Deactivates processing of new services for selected tariffs. Existing services continue to be served.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	Yes	One or more tariff `id` values separated by commas.
`sok`	String	Yes	The value `ok` confirms the operation.

Service import for a processing module

Display list of services for import

Function: processing.import

Result: list of items

UI Equivalent: go to Integration → Processing modules → click Import.

Displays a list of services available for import from an external panel or provider. Supports filtering and sorting.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the processing module.
`item_name`	String	No	Search by service name. Supports the wildcard character `*`.
`account`	Positive integer	No	Filter by client identifier.
`status`	String (enumeration)	No	Filter by service status. Allowed values: `0` — unknown; `1` — ordered; `2` — active; `3` — stopped; `4` — deleted; `5` — being processed.
`sort`	String	No	Column name for sorting: `item_name`, `expiredate`, `account`, `status`.
`pagesize`	Positive integer	No	Number of records per result page.
`startidx`	Non-negative integer	No	Offset of the first record for pagination.

Load list of services for import

Function: processing.import.load

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Import → click Upload.

Retrieves a list of services from the control panel or service provider for subsequent import into BILLmanager.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the processing module.
`itemtype`	String (enumeration)	No	Type of services for import.
`search`	String	No	Service search condition. To import a specific service, enter part of its name or domain name. Leave the field empty to load all services.

Assign a service to a client

Function: processing.import.assign

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Import → click Add.

Binds an imported service to a client in BILLmanager. Confirmation via the sok parameter is required.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the service to assign.
`account`	Positive integer	Yes	Identifier of the client to which the service is bound.
`sok`	String	Yes	The value `ok` confirms the operation.

Delete services from the import list

Function: processing.import.delete

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Import → click Delete.

Deletes selected services from the import list. Does not delete services in the control panel or from the provider. Confirmation via the sok parameter is required.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	Yes	One or more service `id` values separated by commas.
`sok`	String	Yes	The value `ok` confirms the operation.

Clear the service import list

Function: processing.import.clear

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Import → click Purge.

Deletes all services from the import list. Does not delete services in the control panel or from the provider. Confirmation via the sok parameter is required.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the processing module.
`sok`	String	Yes	The value `ok` confirms the operation.

Display service profiles for import

Function: processing.import.service_profile

Result: list of items

Returns a list of contact profiles associated with services being imported (for domain services).

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the service to view profiles.

Edit a service profile

Function: service_profile.edit

Result: successful operation or error message

Used to view and modify parameters of a domain service contact profile.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	No	`id` of the profile to edit. If not specified — creation of a new one.
`plid`	Positive integer	Yes	`id` of the parent service from the `processing.import` function.
`name`	String	No	Profile name for easier identification in the list.
`profiletype`	String (enumeration)	No	Legal status of the contact.
`sok`	String	Yes	The value `ok` confirms saving changes.

Display processing module parameters

Function: processing.customparam

Result: list of items

Returns a list of custom parameters configured for the specified processing module.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the processing module.

Edit a module parameter

Function: processing.customparam.edit

Result: successful operation or error message

The function is used to view and modify custom parameters of a processing module.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	No	`id` of the parameter to edit. If not specified — creation of a new one.
`plid`	Positive integer	Yes	`id` of the parent module from the `processing` function.
`param`	String	No	Parameter type.
`value`	String	No	Parameter value.
`sok`	String	Yes	The value `ok` confirms saving changes.

Delete module parameters

Function: processing.customparam.delete

Result: successful operation or error message

Deletes selected custom parameters of a processing module. Confirmation via the sok parameter is required.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	Yes	One or more parameter `id` values separated by commas.
`sok`	String	Yes	The value `ok` confirms the operation.

Set a filter by module parameters

Function: processing.customparam.filter

Result: successful operation or error message

Filter for processing module parameters. Filter conditions are saved and applied to all subsequent processing.customparam calls until the filter is changed or reset.

Access level: admin

Parameter	Type	Required	Value
`param`	String	No	Filter by parameter name.
`value`	String	No	Filter by parameter value.
`reset`	Flag	No	The value `on` resets all set filters.

Virtual machine discovery

Display VM discovery results

Function: processing.autodiscovering.entry

Result: list of items

UI Equivalent: go to Integration → Processing modules → click Autodiscovering.

Displays a list of virtual machines discovered in an external system (for example, VMmanager 6) but not yet bound to services in BILLmanager.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the processing module. For example, VMmanager 6.
`external_name`	String	No	Search by VM name in the external system.
`owner`	String	No	Filter by VM owner. User email is used for selection.
`account_found`	Flag	No	Filter by client binding presence: `on` — user found; `off` — not found.
`lost_item`	Flag	No	Filter by absence of service in BILLmanager: `on` — VM is absent in the system.
`sort`	String	No	Column name for sorting: `external_name`, `owner`, `ip`, `state`.
`pagesize`	Positive integer	No	Number of records per result page.
`startidx`	Non-negative integer	No	Offset of the first record for pagination.

Start VM discovery

Function: processing.autodiscovering.start

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Autodiscovering → click Start.

Initiates the scanning process of an external system (for example, VMmanager 6) to search for virtual machines that can be imported into BILLmanager. Confirmation via the sok parameter is required.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the processing module.
`sok`	String	Yes	The value `ok` confirms the operation.

Assign a discovered VM to a client

Function: processing.autodiscovering.entry.assign

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Autodiscovering → click Assign.

Binds a discovered virtual machine to a client in BILLmanager and creates the corresponding service. Confirmation via the sok parameter is required.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the discovery record.
`account`	Positive integer	Yes	Client identifier for binding.
`sok`	String	Yes	The value `ok` confirms the operation.

Display metadata of a discovered VM

Function: processing.autodiscovering.entry.metadata

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Autodiscovering → click Information.

Returns detailed technical parameters of the virtual machine obtained from the external system.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the discovery record.

Delete a discovery record

Function: processing.autodiscovering.entry.delete.confirm

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Autodiscovering → click Delete.

Deletes a discovered VM record from the list. Does not delete the virtual machine itself in the external system. Confirmation via the sok parameter is required.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the discovery record.
`sok`	String	Yes	The value `ok` confirms the operation.

Restore a discovery record

Function: processing.autodiscovering.entry.restore

Result: successful operation or error message

UI Equivalent: go to Integration → Processing modules → click Autodiscovering → click Restore.

Launches the process of recreating a virtual machine in the external system based on BILLmanager service data. Confirmation via the sok parameter is required.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the discovery record.
`sok`	String	Yes	The value `ok` confirms the operation.