Domains (domain)
Function: domain
Result: the list of elements
Domains
Access level: admin user
- id — Id
- domain — Domain name
- account — Client
- pricelist — Tariff plan
- project — Provider
- processingmodule — Processing module
- createdate — Creation date
- expiredate — End date
- status_msg -
- item_status -
- cost — Price
Domain information
Function: domain.whois
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 domain 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 domain function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- whois_data — Domain information. WHOIS information
Register new domain/domains
Function: domain.order.register
Register new domain/domains
Access level: user
Resume
Function: domain.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 domain function.
Result: successful operation or error message
Service activation
Function: domain.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 domain 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 domain 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
Name servers
Function: domain.ns
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 domain 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 domain function)
- additional query parameters ...
- Result: successful operation or error message
The list object's parameters or additional query parameters (see above):
- ns0 — NS. Use the following 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. Use the following 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. Use the following 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. Use the following 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. Use the following 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 domain is added with a new line
- provider — .
Set a filter by the selected client
Function: domain.setfilter
Set a filter by the selected client
Access level: admin
File name
Function: domain.doc
Result: the list of elements
Documents
Access level: admin user
- 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
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 domain function).
- elid — unique identifier (id element of domain.doc 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 domain 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 domain function).
- elid — unique identifier (id element of domain.doc function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- doctype — Document type. Document type
Add new document
Function: domain.doc.upload
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 domain function).
- elid — unique identifier (id element of domain.doc 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 domain 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 domain function).
- elid — unique identifier (id element of domain.doc function)
- additional query parameters ...
- Result: successfull operation or error message
The list object's parameters or additional query parameters (see above):
- doctype — Document type. Document type
Delete document
Function: domain.doc.delete
Delete document
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 domain.doc function.
Result: successful operation or error message
View the selected file
Function: domain.doc.file
View the selected file
Access level: admin user
Send files to verify domain contact details
Function: domain.doc.verify
Send files to verify domain contact details
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 domain.doc function.
Result: successful operation or error message
Set the "Verified" status for the selected document
Function: domain.doc.verified
Set the "Verified" status for the selected document
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 domain.doc function.
Result: successful operation or error message
Download document
Function: domain.doc.download
Download document
Access level: admin user
Drill down to User panel
Function: domain.su
Drill down to User panel
Access level: admin
Transfer the domain/domains from another registrar
Function: domain.order.transfer
Transfer the domain/domains from another registrar
Access level: user
Edit properties of the selected service
Function: domain.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 domain 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 domain 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
Delete the selected services
Function: domain.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 domain function.
Result: successful operation or error message
Request domain status and data from the registrar
Function: domain.sync
Request domain status and data from the registrar
Access level: admin
Parameters:
- elid — one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of domain function.
Result: successful operation or error message
Set filter.
domain.filter