Top-level domains (tld)

Top-level domain reference (tld)

Result: list of items.

Top-level domains.

Access level: admin.

UI Equivalent: go to Directories → Top-level domains.

Displays a list of top-level domains. Supports filtering and sorting by parameters.

Parameter	Type	Required	Value
`id`	Positive integer	No	Unique identifier.
`name`	String	No	Top-level domain name. For example: `ru`, `com`, `ac`.

Create or edit a top-level domain

Function: tld.edit

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Add or click Edit.

Used to view, edit or create a TLD object.

Access level: admin.

Parameter	Type	Required	Value
`elid`	Positive integer	No	Unique identifier (element `id` from the `tld` function).
`name`	String	Yes	Top-level domain name. For example: `ru`, `com`, `ac`.
`whois_host`	String	No	Domain name of the WHOIS server for retrieving domain information.
`whois_find_string`	String	No	Substring used to determine domain availability in the WHOIS response. For example: `available`, `not found`.
`whois_timeout`	Positive integer	No	Timeout for waiting for a response from the WHOIS server in seconds. Default timeout is 5 seconds.
`idn_type`	Positive integer	No	Type of supported characters for the domain zone: `0` — Latin characters (a–z), Arabic numerals (0–9), and hyphen; `1` — domain name may contain characters from the national alphabet set; `2` — domain name consists only of characters from the national alphabet set.
`min_lenght`	Positive integer	No	Minimum allowed length of the domain name in characters.
`max_lenght`	Positive integer	No	Maximum allowed length of the domain name after conversion to Punycode.
`info_source`	Positive integer	No	Domain information source. Possible values: `0` — WHOIS; `1` — RDAP.
`rdap_url`	String	No	URL of the RDAP server (Registration Data Access Protocol) for retrieving domain information.
`embedded`	Flag	No	Flag indicating a built-in top-level domain. Default value: `on`.
`sok`	String	Yes	The value `ok` confirms the operation. Without this parameter, changes will not be applied.

Delete a top-level domain

Function: tld.delete

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Delete.

Deletes one or multiple top-level domains.

Access level: admin.

Parameter	Type	Required	Value
`elid`	String (list)	Yes	One or more unique object identifiers separated by commas. Unique identifier — element `id` from the `tld` function.

Allowed character sets

Display list of character sets

Function: tld.idntable

Result: list of items.

UI Equivalent: go to Directories → Top-level domains → click Characters.

Returns character tables allowed for use in domain names. Available only for domains with support for characters from sets.

Access level: admin.

Parameter	Type	Required	Value
`name`	String	No	Character table name.
`status`	String	No	Character table status.

Display character set contents

Function: tld.idntable.view

Result: list of object parameters.

UI Equivalent: go to Directories → Top-level domains → click Characters → click View.

Returns the contents of the selected character table.

Access level: admin.

Parameter	Type	Required	Value
`plid`	Positive integer	Yes	Unique identifier of the parent list (element `id` from the `tld` function).
`elid`	String	Yes	Unique identifier (element `key` from the `tld.idntable` function).

Enable character set

Function: tld.idntable.resume

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Characters → click Enable.

Allows use of the selected character table in domain names.

Access level: admin.

Parameter	Type	Required	Value
`elid`	String (list)	Yes	One or more unique object identifiers separated by commas. Unique identifier — element `key` from the `tld.idntable` function.

Disable character set

Function: tld.idntable.suspend

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Characters → click Disable.

Prohibits use of the selected character table in domain names.

Access level: admin.

Parameter	Type	Required	Value
`elid`	String (list)	Yes	One or more unique object identifiers separated by commas. Unique identifier — element `key` from the `tld.idntable` function.

Update RDAP data

Function: tld.rdap.update

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Update RDAP.

Populates the rdap_url fields for top-level domains based on official IANA data from the source https://data.iana.org/rdap/dns.json.

Access level: admin.

Manage TLD contact parameters

Function: tld.service_profileparam

Result: list of items.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters.

Returns a list of contact parameters for top-level domains. All filtering parameters are optional.

Access level: admin.

Parameter	Type	Required	Value
`id`	Positive integer	No	Unique parameter identifier.
`name`	String	No	Parameter name for display in the interface.
`intname`	String	No	Internal parameter identifier (name for staff).
`hint`	String	No	Field hint displayed on hover.
`country`	String (list)	No	Countries for which the parameter is relevant. The value `All` means application for all countries.
`profiletype`	String (enumeration)	No	Contact type. Allowed values: `1` — individual; `2` — legal entity; `3` — sole proprietor.
`contacttype`	String (enumeration)	No	Contact view. Allowed values: `1` — client contact; `2` — owner contact; `3` — billing contact; `4` — administrative contact; `5` — technical contact; `6` — CED (variant for the `.asia` domain zone).
`processingmodule`	String (list)	No	Registrar processing modules connected to the parameter.
`required`	Flag	No	Flag indicating that the parameter is required.
`active`	Flag	No	Flag indicating parameter activity.
`baseparam`	Flag	No	Flag indicating a default parameter (cannot be disabled or deleted).
`orderpriority`	Positive integer	No	Parameter priority when sorting the list (ascending).

Create a contact parameter

Function: tld.service_profileparam.add

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → click Add.

Creates a new domain contact parameter with binding to processing modules.

Access level: admin.

Parameter	Type	Required	Value
`plid`	Positive integer	Yes	Unique identifier of the domain zone (element `id` from the `tld` function).
`processingmodule`	String (list)	Yes	Comma-separated list of registrar processing module IDs to which the parameter is connected.
`name`	String	No	Parameter name for display in the interface.
`intname`	String	Yes	Internal parameter identifier. Latin characters, no spaces, does not start with a digit.
`hint`	String	No	Field hint displayed on hover.
`country`	String (list)	Yes	List of countries for which the parameter is relevant.
`profiletype`	String (list)	Yes	Contact type. Allowed values: `1` — individual; `2` — legal entity; `3` — sole proprietor.
`contacttype`	String (list)	Yes	Contact view. Allowed values: `1` — client contact; `2` — owner contact; `3` — billing contact; `4` — administrative contact; `5` — technical contact; `6` — CED (variant for the `.asia` domain zone).
`inputtype`	Positive integer	No	Input field type `0` — string; `1` — list; `2` — multiple; `3` — flag; `4` — text area.
`validator`	String (enumeration)	No	Value validation function: `email`, `phone`, `int`, `latin`, `date`, etc.
`orderpriority`	Positive integer	No	Parameter priority when sorting (ascending).
`sok`	String	Yes	The value `ok` confirms the operation.

Edit a contact parameter

Function: tld.service_profileparam.edit

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → select a parameter → click Edit.

Allows modification of a domain contact parameter.

Access level: admin.

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	Unique identifier of the parameter being edited (element `id` from the `tld.service_profileparam` function).
`name`	String	No	Parameter name for display in the interface.
`intname`	String	No	Internal parameter identifier.
`hint`	String	No	Field hint.
`country`	String (list)	No	List of countries for which the parameter is relevant.
`profiletype`	String (list)	No	Contact type. Allowed values: `1` — individual; `2` — legal entity; `3` — sole proprietor.
`contacttype`	String (list)	No	Contact view. Allowed values: `1` — client contact; `2` — owner contact; `3` — billing contact; `4` — administrative contact; `5` — technical contact; `6` — CED (variant for the `.asia` domain zone).
`inputtype`	Positive integer	No	Input field type `0` — string; `1` — list; `2` — multiple; `3` — flag; `4` — text area.
`validator`	String (enumeration)	No	Value validation function.
`orderpriority`	Positive integer	No	Parameter priority when sorting.
`minlength_N`	Positive integer	No	Minimum length for a processing module, where `N` is the processing module ID.
`maxlength_N`	Positive integer	No	Maximum length for a processing module, where `N` is the processing module ID.
`required_N`	Flag	No	Required flag for a processing module, where `N` is the processing module ID.
`sok`	String	Yes	The value `ok` confirms the operation.

Configure a processing module for a parameter

Function: tld.service_profileparam.processingmodule.edit

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → click Processing modules → select a processing module → click Edit.

Configuration of required flag and length constraints for a parameter in a specific registrar processing module.

Access level: admin.

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	Unique identifier of the processing module setting.
`required`	Flag	No	Make the parameter required for this processing module.
`minlength`	Positive integer	No	Minimum number of characters for a text field.
`maxlength`	Positive integer	No	Maximum number of characters for a text field.
`sok`	String	Yes	The value `ok` confirms the operation.

List of parameter processing modules

Function: tld.service_profileparam.processingmodule

Result: list of items.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → click Processing modules.

Returns a list of registrar processing modules connected to the parameter.

Access level: admin.

Parameter	Type	Required	Value
`id`	Positive integer	No	Unique connection identifier.
`name`	String	No	Processing module name.
`active`	Flag	No	Flag indicating connection activity.
`orderpriority`	Positive integer	No	Processing module priority when sorting.

Enable a parameter processing module

Function: tld.service_profileparam.processingmodule.resume

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → click Processing modules → click Enable.

Activates the connection of a parameter to a processing module. Supports batch operation.

Access level: admin.

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

Disable a parameter processing module

Function: tld.service_profileparam.processingmodule.suspend

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → click Processing modules → click Disable.

Deactivates the connection of a parameter to a processing module. Supports batch operation.

Access level: admin.

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

Configure values for "List" type parameters

Function: tld.service_profileparam.value

Result: list of items.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → click Values.

Returns a list of allowed values for parameters of the "List" type.

Access level: admin.

Parameter	Type	Required	Value
`id`	Positive integer	No	Unique value identifier.
`name`	String	No	Value name for display.
`intname`	String	No	Internal value name for transmission to the processing module.
`orderpriority`	Positive integer	No	Value priority when sorting (ascending).

Create or edit a list value

Function: tld.service_profileparam.value.edit

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → click Values → click Add or click Edit.

Allows viewing, editing, or creating a value for a parameter of the "List" type.

Access level: admin.

Parameter	Type	Required	Value
`plid`	Positive integer	Yes	Unique identifier of the parent parameter (element `id` from the `tld.service_profileparam` function).
`elid`	Positive integer	No	Unique identifier of the value being edited (element `id` from the `tld.service_profileparam.value` function).
`name`	String	Yes	Value name for display.
`intname`	String	Yes	Internal value name. Latin characters, no spaces, does not start with a digit.
`code`	String	No	Value code for transmission to the processing module.
`orderpriority`	Positive integer	No	Value priority when sorting (ascending).
`sok`	String	Yes	The value `ok` confirms the operation.

Delete a list value

Function: tld.service_profileparam.value.delete

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → click Values → click Delete.

Supports deletion of multiple values separated by commas.

Access level: admin.

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

Move a list value up

Function: tld.service_profileparam.value.up

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → click Values → click Up.

Access level: admin.

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the value to move.

Move a list value down

Function: tld.service_profileparam.value.down

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → click Values → click Down.

Access level: admin.

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the value to move.

Enable a parameter

Function: tld.service_profileparam.resume

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → click Enable.

Activates a domain contact parameter. Supports batch operation.

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.

Disable a parameter

Function: tld.service_profileparam.suspend

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → click Disable.

Deactivates a domain contact parameter. Supports batch operation.

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.

Restore default parameters

Function: tld.service_profileparam.restoredefault

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → click Restore.

Restores the list of domain contact parameters to default values for the specified domain zone.

Access level: admin.

Parameter	Type	Required	Value
`plid`	Positive integer	Yes	Unique identifier of the domain zone (element `id` from the `tld` function).
`sok`	String	Yes	The value `ok` confirms the operation.

Move a parameter up

Function: tld.service_profileparam.up

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → click Up.

Access level: admin.

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the parameter to move.

Move a parameter down

Function: tld.service_profileparam.down

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → click Down.

Access level: admin.

Parameter	Type	Required	Value
`elid`	Positive integer	Yes	`id` of the parameter to move.

Set a filter

Function: tld.service_profileparam.filter

Result: successful operation or error message.

UI Equivalent: go to Directories → Top-level domains → click Contact parameters → click Filter.

Saves the current filter settings. These filters will be applied every time the parameter list is loaded until you change or clear them.

Access level: admin.

Parameter	Type	Required	Value
`name`	String	No	Search by parameter name. Supports the wildcard character `*`.
`intname`	String	No	Search by Internal parameter identifier.
`status`	Flag	No	Filter by status. Possible values: `on` — active; `off` — disabled.
`country`	String (list)	No	Filter by country.
`profiletype`	String (list)	No	Filter by contact type.
`contacttype`	String (list)	No	Filter by contact view.
`reset`	Flag	No	If set to `on`, clears all currently active filters.
`sok`	String	Yes	The value `ok` confirms saving the filter.