Domains (domain)

domain

Result: list of elements.

Domains.

Access level: admin user.

Parameter	Value
`id`	Id.
`domain`	Domain name.
`account`	Client.
`pricelist`	Tariff.
`project`	Provider.
`processingmodule`	Processing module.
`createdate`	Creation date.
`expiredate`	Expires on.
`status_msg`	Current status description.
`item_status`	Service status. Possible values: `1` — ordered; `2` — active; `3` — suspended; `4` — deleted; `5` — processing.
`cost`	Cost.

Domain information

Function: domain.whois

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 domain function);
Result: list of object parameters.

Create object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- additional request parameters ...
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 domain function);
- additional request parameters ...
Result: successful operation or error message.

List of object parameters or additional request parameters:

Parameter	Value
`whois_data`	Domain information. WHOIS data for the domain.

Register new domain(s)

Function: domain.order.register

Access level: user.

Resume

Function: domain.resume

Access level: admin.

Parameters:

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

Result: successful operation or error message.

Open service

Function: domain.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 domain function);
Result: list of object parameters.

Create object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- additional request parameters ...
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 domain function);
- additional request parameters ...
Result: successful operation or error message.

List of object parameters or additional request parameters:

Parameter	Value
`processingmodule`	Processing module assigned to the service.

Name servers

Function: domain.ns

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 domain function);
Result: list of object parameters.

Create object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- additional request parameters ...
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 domain function);
- additional request parameters ...
Result: successful operation or error message.

List of object parameters or additional request parameters:

Parameter	Value
`ns0`	NS. Record format "ns.example.com" or "ns.example.com/1.1.1.1" or "ns.example.com/1.1.1.1,2.2.2.2".
`ns1`	NS. Record format "ns.example.com" or "ns.example.com/1.1.1.1" or "ns.example.com/1.1.1.1,2.2.2.2".
`ns2`	NS. Record format "ns.example.com" or "ns.example.com/1.1.1.1" or "ns.example.com/1.1.1.1,2.2.2.2".
`ns3`	NS. Record format "ns.example.com" or "ns.example.com/1.1.1.1" or "ns.example.com/1.1.1.1,2.2.2.2".
`ns_additional`	Additional NS. Record format "ns.example.com" or "ns.example.com/1.1.1.1" or "ns.example.com/1.1.1.1,2.2.2.2". Each additional name server is specified on a new line.
`provider`	Name server provider (domain registrar).

Set client filter

Function: domain.setfilter

Access level: admin.

File name

Function: domain.doc

Result: list of elements.

Documents.

Access level: admin user.

Parameter	Value
`id`	ID.
`profile`	Domain contact.
`doctype`	Document type.
`name`	File name.
`size`	Size.
`props`	Properties.

Document type

Function: domain.doc.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 domain function);
- elid — unique identifier (id element from the domain.doc 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 domain function);
- additional request parameters ...
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 domain function);
- elid — unique identifier (id element from the domain.doc function);
- additional request parameters ...
Result: successful operation or error message.

List of object parameters or additional request parameters:

Parameter	Value
`doctype`	Type of document being uploaded.

Add document

Function: domain.doc.upload

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 domain function);
- elid — unique identifier (id element from the domain.doc 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 domain function);
- additional request parameters ...
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 domain function);
- elid — unique identifier (id element from the domain.doc function);
- additional request parameters ...
Result: successful operation or error message.

List of object parameters or additional request parameters:

Parameter	Value
`doctype`	Type of document being uploaded.

Delete document

Function: domain.doc.delete

Access level: admin user.

Parameters:

elid — one or more unique object identifiers separated by comma and following space ", ". Unique identifier is the id element from the domain.doc function.

Result: successful operation or error message.

View selected file

Function: domain.doc.file

Access level: admin user.

Submit files to verify domain contact data

Function: domain.doc.verify

Access level: admin user.

Parameters:

elid — one or more unique object identifiers separated by comma and following space ", ". Unique identifier is the id element from the domain.doc function.

Result: successful operation or error message.

Set document verification status

Function: domain.doc.verified

Access level: admin user.

Parameters:

elid — one or more unique object identifiers separated by comma and following space ", ". Unique identifier is the id element from the domain.doc function.

Result: successful operation or error message.

Download document

Function: domain.doc.download

Access level: admin user.

Log in to panel with user privileges

Function: domain.su

Access level: admin.

Transfer domain(s) from another registrar

Function: domain.order.transfer

Access level: user.

Edit service

Function: domain.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 domain function);
Result: list of object parameters.

Create object:

Parameters:
- sok — parameter value must be non-empty, usually ok;
- additional request parameters ...
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 domain function);
- additional request parameters ...
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`	Activation date. Actual service start date.
`expiredate`	Expires on. Service validity period.
`scheduledclose`	To enable this option, use the value `on`. Scheduled deletion at the end of the paid period. Optional parameter.
`reboot`	To enable this option, use the value `on`. Optional parameter.
`note`	Service comment, visible only to provider staff.
`noexpense`	To enable this option, use the value `on`. Select this option if no funds should be charged or refunded for the current resource modification operation. Optional parameter.

Delete selected services

Function: domain.delete

Access level: admin user.

Parameters:

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

Result: successful operation or error message.

Request domain data and status from registrar

Function: domain.sync

Access level: admin.

Parameters:

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

Result: successful operation or error message.

Set filter

Function: domain.filter

Access level: user