Top-level domains (tld)

tld

Result: list of elements.

Top-level domains.

Access level: admin.

Field	Value
`id`	Unique identifier.
`name`	Top-level domain name. For example: `ru`, `com`, `ac`.

Delete

Function: tld.delete

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 tld function.

Result: successful operation or error message.

Top-level domain

Function: tld.edit

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 tld 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 tld function);
- additional request parameters ...
Result: successful operation or error message.

List of object parameters or additional request parameters:

Field	Type	Default	Value
`id`	int	—	Unique identifier.
`name`	varchar(63)	—	Top-level domain name. For example: `ai`, `com`, `ac`.
`whois_host`	varchar(255)	NULL	WHOIS server domain name for retrieving domain information.
`whois_find_string`	varchar(255)	NULL	Substring used to determine domain availability in the WHOIS response. For example: `available`, `not found`.
`whois_timeout`	int	NULL	WHOIS server response timeout in seconds. If set to `NULL`, the default timeout of 5 seconds is used.
`idn_type`	int	0	Character set supported by the domain zone: `0` — Latin characters (a–z), Arabic numerals (0–9), and hyphen. IDN is not supported; 1 — domain name may contain national alphabet characters from the character set; 2 — domain name consists exclusively of national alphabet characters from the character set.
`min_lenght`	int	2	Minimum allowed domain name length in characters.
`max_lenght`	int	63	Maximum allowed domain name length after Punycode conversion.
`info_source`	int	0	Domain information source: `0` — WHOIS; 1 — RDAP.

`rdap_url`	varchar(255)	NULL	RDAP (Registration Data Access Protocol) server URL for retrieving domain information.

Character tables

Function: tld.idntable

Result: list of elements.

Access level: admin.

Parameter	Value
`name`	Name.
`status`	Status.

Suspend

Function: tld.idntable.suspend

Access level: admin.

Parameters:

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

Result: successful operation or error message.

Character table content

Function: tld.idntable.view

Access level: admin.

Used to view object parameters, modify objects, and create new objects.

View object parameters:

Parameters:
- plid — unique parent list identifier (id element from the tld function);
- elid — unique identifier (key element from the tld.idntable 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 tld 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 tld function);
- elid — unique identifier (key element from the tld.idntable function);
- additional request parameters ...
Result: successful operation or error message.

Resume

Function: tld.idntable.resume

Access level: admin.

Parameters:

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

Result: successful operation or error message.

Update RDAP data

Function: tld.rdap.update

Access level: admin.

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

Result: successful operation or error message.