Domain API Reference

Methods

domain.available(apikey, domains[, opts=nil])

Check the availability of some domains.

Changed in version 3.1.9: add opts parameter

Note

If a language is specified in opts parameter, it will be for all IDN domains in the list

Note

The size of the struct returned by this methods is the same as the number of domains.

Parameters:
  • apikey (string) – API connection key
  • domains (array) – List of domain names
  • opts (struct) – Options for search
Returns:

struct – Name of domains associated to a status

domain.count(apikey[, opts=nil])

Count domains associated to the contact represented by apikey.

Parameters:
Returns:

int – Number of domains

domain.create(apikey, domain, params)

Create a domain.

Warning

This is not a free operation. Please ensure your prepaid account has enough credit. Look at the catalog listings to get the price.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • params (struct) – Parameters
Returns:

struct – Operation domain_create

domain.info(apikey, domain)

Get domain information.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
Returns:

struct – Domain information

domain.list(apikey[, opts=nil])

List domains associated to the contact represented by apikey.

Parameters:
Returns:

list of struct – Domain information

domain.price(apikey, domains[, opts=nil])

Return the price of some domains, and their availablity.

Deprecated in favor of domain.price.list() method for better accuracy.

New in version 3.3.28.

Parameters:
  • apikey (string) – API connection key
  • domains (array) – List of domain names
  • opts (struct) – Parameters
Returns:

struct – list of DomainPriceListReturn

domain.push(apikey, domain, target)

change the tag of a .UK domain.

New in version 3.3.30.

Changed in version 3.3.38: Only for outgoing transfers of .uk

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • target (string) – New target of the domain
Returns:

boolean – 1 if the operation succeeded

domain.release(apikey, domain)

Release a domain from a reseller account

Note

Only resellers can use this method. It will have no effect for other kind of accounts.

Warning

This will not release any contacts from your account that are associated to the domain name. If you want to release any associated contacts to the domain, such as the owner, please use the contact.release method. This will allow the contacts to manage the domain name autonomously.

New in version 3.2.10.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
Returns:

struct – Operation domain_release

domain.renew(apikey, domain, params)

Renew a domain.

Warning

This is not a free operation. Please ensure your prepaid account has enough credit. Look at the catalog listings to get the price.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • params (struct) – Parameters
Returns:

struct – Operation domain_renew

domain.restore(apikey, domain, params)

Restore a domain.

New in version 3.1.6.

Warning

This is not a free operation. Please ensure your prepaid account has enough credit. Look at the catalog listings to get the price.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • params (struct) – Parameters
Returns:

struct – Operation domain_restore

domain.price.list(apikey[, opts=nil])

Provide detailed domain pricing informations for many TLDs.

See usage example at http://doc.rpc.gandi.net/domain/usage.html#domain-price-list.

Parameters:
Returns:

list of struct – List of suggestions

domain.authinfo.reset(apikey, domain)

Asks for a new authinfo code generation on a given domain.

New in version 3.3.32.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
Returns:

struct – authinfo data

domain.owner.set(apikey, domain, params)

Define the new owner of a domain and with him/her the ‘admin’, ‘tech’ and ‘bill’ contacts.

A special method is needed for this action because special rules may apply regarding of the tld.

Warning

This is not a free operation. Please ensure your prepaid account has enough credit. Look at the catalog listings to get the price.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • params (struct) – Parameters
Returns:

struct – Operation change_owner

domain.contacts.set(apikey, domain, params)

Set the contacts of a domain.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • params (struct) – Contacts
Returns:

struct – Operation domain_contact_change

domain.webredir.count(apikey, domain[, opts=nil])

Count redirections associated to the given domain.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • opts (struct) – Filtering options
Returns:

int – Number of redirections

domain.webredir.create(apikey, domain, params)

Create a web redirection.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • params (struct) – Parameters
Returns:

struct – Redirection information

domain.webredir.delete(apikey, domain, host)

Delete a web redirection.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • host (string) – Redirection
Returns:

boolean – 1

domain.webredir.list(apikey, domain[, opts=nil])

List redirections associated to the given domain.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • opts (struct) – Filtering options
Returns:

struct – List of redirections

domain.webredir.update(apikey, domain, host, params)

Update a web redirection.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • host (struct) – Redirection
  • params (struct) – Parameters
Returns:

struct – Redirection information

domain.status.lock(apikey, domain)

Lock a domain.

Set the clientTransferProhibited status value.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
Returns:

struct – Operation domain_status_update

domain.status.unlock(apikey, domain)

Unlock a domain.

Unset the clientTransferProhibited status value.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
Returns:

struct – Operation domain_status_update

domain.host.count(apikey, domain[, opts=nil])

Count glue records associated to the given domain.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • opts (struct) – Filtering options
Returns:

int – Number of glue records

domain.host.create(apikey, fqdn, ips)

Create a glue record

Parameters:
  • apikey (string) – API connection key
  • fqdn (string) – full name for the glue record (eg: ns.domain.net)
  • ips (array) – List of IP addresses
Returns:

struct – Operation host_create

domain.host.delete(apikey, fqdn)

Delete a glue record

Note

it’s impossible to delete a host that is still linked to its domain (immediate error) … or any other domain at the same registry (the operation will fail)

Parameters:
  • apikey (string) – API connection key
  • fqdn (string) – full name for the glue record (eg: ns.domain.net)
Returns:

struct – Operation host_delete

domain.host.info(apikey, fqdn)

Get glue record information.

Parameters:
  • apikey (string) – API connection key
  • fqdn (string) – full name for the glue record (eg: ns.domain.net)
Returns:

struct – Glue record information

domain.host.list(apikey, domain[, opts=nil])

List glue records associated to the given domain.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • opts (struct) – Filtering options
Returns:

list of struct – Glue records

domain.host.update(apikey, fqdn, ips)

Update a glue record

Parameters:
  • apikey (string) – API connection key
  • fqdn (string) – full name for the glue record (eg: ns.domain.net)
  • ips (array) – List of IP addresses
Returns:

struct – Operation host_update_ip

domain.mailbox.count(apikey, domain[, opts=nil])

Count mailboxes associated to the given domain.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • opts (struct) – Filtering options
Returns:

int – Number of mailboxes

domain.mailbox.create(apikey, domain, login, params)

Create a mailbox.

Warning

This method cannot be used if you migrated your mailbox to our new system

Changed in version 3.1.8: Create a mailbox_add operation

Changed in version 3.3.0: Operation renamed to mailbox_create

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • login (string) – Login of the mailbox
  • params (struct) – Parameters
Returns:

struct – Mailbox information

domain.mailbox.delete(apikey, domain, login)

Delete a mailbox

Warning

This method cannot be used if you migrated your mailbox to our new system

Changed in version 3.1.8: Create mailbox_del operation

Changed in version 3.3.0: Operation renamed to mailbox_delete

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • login (string) – Login of the mailbox
Returns:

boolean – 1 on success, 0 otherwise

domain.mailbox.info(apikey, domain, login)

Get mailbox information.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • login (string) – Login of the mailbox
Returns:

struct – Mailbox information

domain.mailbox.list(apikey, domain[, opts=nil])

List mailboxes associated to the given domain.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • opts (struct) – Filtering options
Returns:

list of struct – Mailbox information

domain.mailbox.purge(apikey, domain, login)

Purge a mailbox

Warning

This method cannot be used if you migrated your mailbox to our new system

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • login (string) – Login of the mailbox
Returns:

struct – Operation mailbox_purge

domain.mailbox.update(apikey, domain, login, params)

Update a mailbox.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • login (string) – Login of the mailbox
  • params (struct) – Parameters
Returns:

struct – Mailbox information

domain.mailbox.alias.set(apikey, domain, login, aliases)

Overwrite aliases for a mailbox.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • login (string) – Login of the mailbox
  • aliases (array) – List of aliases
Returns:

struct – Mailbox information

domain.mailbox.responder.activate(apikey, domain, login, params)

Schedule a responder activation.

Note

The response email will be sent only once per day and per sender.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • login (string) – Login of the mailbox
  • params (struct) – Parameters
Returns:

struct – Operation responder_activate

domain.mailbox.responder.deactivate(apikey, domain, login[, params=nil])

Schedule a responder deactivation.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • login (string) – Login of the mailbox
  • params (struct) – Parameters
Returns:

struct – Operation responder_deactivate

domain.forward.count(apikey, domain[, opts=nil])

Count mail forwards related to a domain.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • opts (struct) – Filtering options
Returns:

int – Number of forwards

domain.forward.create(apikey, domain, source, params)

Create a mail forward.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • source (string) – Source of the forward
  • params (struct) – Parameters
Returns:

struct – Forward information

domain.forward.delete(apikey, domain, source)

Delete a forward.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • source (string) – Source of the forward
Returns:

boolean – 1

domain.forward.list(apikey, domain[, opts=nil])

List mail forwards related to a domain.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • opts (struct) – Filtering options
Returns:

list of struct – List of forwards

domain.forward.update(apikey, domain, source, params)

Update a forward.

This method will override email addresses for this forward

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • source (string) – Source of the forward
  • params (struct) – Parameters
Returns:

struct – Forward information

domain.packmail.autorenew(apikey, gmail, params)

Activate the autorenew for a Packmail.

Warning

This method cannot be used if you migrated your mailbox to our new system

Parameters:
  • apikey (string) – API connection key
  • gmail (string) – Name of the domain
  • params (struct) – Parameters
Returns:

struct – Operation packmail_autorenew

domain.packmail.create(apikey, gmail, params)

Switch a Gandi Mail to the paid version, known as Packmail.

Warning

This method cannot be used if you migrated your mailbox to our new system

Warning

This is not a free operation. Please ensure your prepaid account has enough credit. Look at the catalog listings to get the price.

Parameters:
  • apikey (string) – API connection key
  • gmail (string) – Name of the domain
  • params (struct) – Parameters
Returns:

struct – Operation packmail_activate

domain.packmail.delete(apikey, gmail)

Switch back a Gandi Mail to the free version.

Warning

This method cannot be used if you migrated your mailbox to our new system

Parameters:
  • apikey (string) – API connection key
  • gmail (string) – Name of the domain
Returns:

struct – Operation packmail_deactivate

domain.packmail.info(apikey, gmail)

Get Gandi Mail information.

Warning

This method cannot be used if you migrated your mailbox to our new system

Parameters:
  • apikey (string) – API connection key
  • gmail (string) – Name of the domain
Returns:

struct – Packmail information

domain.packmail.renew(apikey, gmail, params)

Renew a Packmail.

Warning

This method cannot be used if you migrated your mailbox to our new system

Warning

This is not a free operation. Please ensure your prepaid account has enough credit. Look at the catalog listings to get the price.

Parameters:
  • apikey (string) – API connection key
  • gmail (string) – Name of the domain
  • params (struct) – Parameters
Returns:

struct – Operation packmail_renew

domain.packmail.update(apikey, gmail, params)

Change the storage quota of a Packmail.

Warning

This method cannot be used if you migrated your mailbox to our new system

Warning

This is not a free operation. Please ensure your prepaid account has enough credit. Look at the catalog listings to get the price.

Parameters:
  • apikey (string) – API connection key
  • gmail (string) – Name of the domain
  • params (struct) – Parameters
Returns:

struct – Operation packmail_update, packmail_upgrade packmail_downgrade

domain.tld.list(apikey[, opts=nil])

List available TLD extensions.

Parameters:
Returns:

list of struct – TLD information

domain.tld.region(apikey[, opts=nil])

List available TLD extensions folded by region.

Parameters:
Returns:

list of struct – Folded TLD information

domain.transferin.available(apikey, fqdn[, authinfo=nil])

Check if a Domain is transferable

you can learn about what information this method returns at http://doc.rpc.gandi.net/domain/usage.html#check-transfer-availability

New in version 3.1.9.

Parameters:
  • apikey (string) – API connection key
  • fqdn (string) – fqdn to transfer in
  • authinfo (string) – The authinfo domain
Returns:

boolean – Transfer availability

domain.transferin.proceed(apikey, domain, params)

Transfer a domain

Warning

This is not a free operation. Please ensure your prepaid account has enough credit. Look at the catalog listings to get the price.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • params (struct) – Parameters
Returns:

struct – Operation domain_transfer_in

domain.transferin.resend_foa(apikey, fqdn)

This method allows to take a Transferin Operation back to the point where it extracts the email for the Domain Representative from the WHOIS record and sends FOAs again.

This is mostly in order to fix specific issues where WHOIS record data was wrong, has been updated since and we now want to send the FOAs anew.

On v3 this works on Transfer Operations in the RUN step and check_foa_response inner step. On v5 this works also on operations in the ERROR step.

Parameters:
  • apikey (struct) – API connection key
  • fqdn (string) – The fqdn of the transfer
Returns:

boolean – Status

domain.transferin.update_authinfo(apikey, fqdn, authinfo)

Update the authcode of a transfer.

Modify the operparam of the operation linked to the transfer. and reset the step of the operation to ‘WAIT’.

Parameters:
  • apikey (struct) – API connection key
  • fqdn (string) – The fqdn of the transfer
  • authinfo (string) – The new authinfo
Returns:

boolean – Status

domain.nameservers.set(apikey, domain, nameservers[, options=nil])

Set domain nameservers.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • nameservers (array) – List of nameservers
  • options (struct) – Additional options
Returns:

struct – Operation domain_ns_set

domain.zone.clone(apikey, zone_id[, version_id=0, params=nil])

Clone a zone and its records.

This creates a new zone based on the zone referenced by zone_id and its version referenced by version_id.

If a version_id of 0 is provided, the current version of the zone referenced by zone_id will be used.

Parameters:
  • apikey (string) – API connection key
  • zone_id (int) – ID of the Zone
  • version_id (int) – Id of the version
  • params (struct) – Parameters
Returns:

struct – Zone information

domain.zone.count(apikey[, opts=nil])

Counts accessible zones.

Parameters:
Returns:

int – Number of zones

domain.zone.create(apikey, params)

Create an empty zone.

Parameters:
  • apikey (string) – API connection key
  • params (struct) – Parameters
Returns:

struct – Zone information

domain.zone.delete(apikey, zone_id)

Delete a zone.

Warning

All versions and records of the given zone are also deleted.

Parameters:
  • apikey (string) – API connection key
  • zone_id (int) – ID of the Zone
Returns:

boolean – 1

domain.zone.info(apikey, zone_id)

Get zone information.

Parameters:
  • apikey (string) – API connection key
  • zone_id (int) – ID of the Zone
Returns:

struct – Zone information

domain.zone.list(apikey[, opts=nil])

List accessible DNS zones.

Accessible zones fit in three categories: public Gandi zones, zones created by the contact and active zones linked to domains for which the contact represented by apikey is at least technical.

Parameters:
Returns:

list of struct – Zone information

domain.zone.set(apikey, domain, zone_id)

Set the current zone of a domain.

Warning

It can take up to 20 minutes for a new zone or version to be loaded on Gandi’s nameservers. See Gandi DNS FAQ.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • zone_id (int) – ID of the Zone
Returns:

struct – Domain information

domain.zone.update(apikey, zone_id, params)

Update a zone.

Parameters:
  • apikey (string) – API connection key
  • zone_id (int) – ID of the Zone
  • params (struct) – Parameters
Returns:

struct – Zone information

domain.zone.version.count(apikey, zone_id)

Count the versions associated with a zone.

New in version 3.1.7.

Parameters:
  • apikey (string) – API connection key
  • zone_id (int) – id of the Zone
Returns:

int – Number of versions associated with this zone.

domain.zone.version.delete(apikey, zone_id, version_id)

Delete a specific version of a zone.

Parameters:
  • apikey (string) – API connection key
  • zone_id (int) – id of the Zone
  • version_id (int) – version_id to delete
Returns:

boolean – 1 if the operation succeeds

domain.zone.version.list(apikey, zone_id[, version_id=nil])

List a zone’s versions, with their creation date.

New in version 3.1.7.

Parameters:
  • apikey (string) – API connection key
  • zone_id (int) – id of the Zone
  • version_id (int) – Optional restriction to a single version
Returns:

list of struct – list of zone versions

domain.zone.version.new(apikey, zone_id[, version_id=0])

Create a new version from another version. This will duplicate the version’s records.

Note that cloned records will have new identifiers.

Parameters:
  • apikey (string) – API connection key
  • zone_id (int) – id of the Zone
  • version_id (int) – version_id to start from, current version
Returns:

int – the created version number

domain.zone.version.set(apikey, zone_id, version_id)

Set the active version of a zone.

Warning

It can take up to 20 minutes for a new zone or version to be loaded on Gandi’s nameservers. See Gandi DNS FAQ.

Parameters:
  • apikey (string) – API connection key
  • zone_id (int) – id of the Zone
  • version_id (int) – version_id to activate
Returns:

boolean – 1 if the operation succeeds

domain.zone.record.add(apikey, zone_id, version_id, params)

Add a new record to zone/version

Changed in version 3.3.34: won’t create duplicate records. See changelog

Parameters:
  • apikey (string) – API connection key
  • zone_id (int) – zone to add to
  • version_id (int) – version_id to add to
  • params (struct) – the record definition
Returns:

struct – The new record

domain.zone.record.count(apikey, zone_id, version_id[, opts=nil])

Count number of records for a given zone/version, with an optional filter (see record_list())

Parameters:
  • apikey (string) – API connection key
  • zone_id (int) – id of the Zone
  • version_id (int) – version_id to count, 0 for active version
  • opts (struct) – optional filters
Returns:

int – the count

domain.zone.record.delete(apikey, zone_id, version_id[, opts=nil])

Remove some records from a zone/version, filters are the same as for list()

Parameters:
  • apikey (string) – API connection key
  • zone_id (int) – id of the Zone
  • version_id (int) – version_id to delete from
  • opts (struct) – which records to delete
Returns:

int – number of records deleted

domain.zone.record.list(apikey, zone_id, version_id[, opts=nil])

List records of a version of a DNS zone.

Parameters:
  • apikey (string) – API connection key
  • zone_id (int) – ID of the Zone
  • version_id (int) – version_id to list, 0 for active version
  • opts (struct) – optional filters
Returns:

struct – a list of records

domain.zone.record.set(apikey, zone_id, version_id, params)

Sets the records for a zone/version

Parameters:
  • apikey (string) – API connection key
  • zone_id (int) – id of the Zone
  • version_id (int) – version_id to list
  • params (struct) – the record definition
Returns:

struct – The records

domain.zone.record.update(apikey, zone_id, version_id, opts, params)

Update one record by its id.

New in version 3.1.7.

Parameters:
Returns:

list of struct – the updated record

domain.dnssec.create(apikey, domain, params[, orga_params=nil])

Create a new operation to add a DNSSEC key to a domain.

Note

there is currently a limit of 4 keys per domain

New in version 3.1.0.

Parameters:
Returns:

struct – Operation domain_dnssec_add

domain.dnssec.delete(apikey, key_id[, orga_params=nil])

Create a new operation to delete a DNSSEC key (remove it from its domain)

New in version 3.1.0.

Parameters:
  • apikey (string) – API connection key
  • key_id (int) – key identifier
  • orga_params (struct) – orga parameters
Returns:

struct – Operation domain_dnssec_delete

domain.dnssec.list(apikey, domain)

List DNSSEC keys associated to the given domain.

New in version 3.1.0.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
Returns:

struct – List of DNSSEC keys

domain.dnssec.set(apikey, domain, params[, orga_params=nil])

Create a new operation to atomically set DNSSEC keys on a domain.

Note

this will either remove all existing keys and add the provided list, or raise

New in version 3.3.36.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • params (array) – key specifications
  • orga_params (struct) – orga parameters
Returns:

struct – Operation domain_dnssec_set

domain.reseller.set(apikey, domain[, authinfo=nil])

Set a new reseller to a domain

New in version 3.1.9.

Changed in version 3.3.38: added optional parameters for authinfo

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • authinfo (string) – The current authinfo
Returns:

struct – Operation domain_transfer_reseller

domain.tag.add(apikey, tag, fqdns)

Attach a tag to one or more domains. If the tag doesn’t already exist, create it.

Parameters:
  • apikey (string) – API connection key
  • tag (struct) – a given tag
  • fqdns (struct) – a given domain or list of domains
Returns:

struct – list of tags info dicts

domain.tag.list(apikey[, opts=nil])

List all tags that belong to the logged user.

Parameters:
Returns:

struct – list of tags info dicts

domain.tag.remove(apikey, tag, fqdns)

detach a tag from a full qualified domain list.

Parameters:
  • apikey (string) – API connection key
  • tag (struct) – a given tag
  • fqdns (struct) – a given domain or list of domains
Returns:

boolean –

domain.tag.set(apikey, domain, tags)

Set tags to one domain.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • tags (struct) – a tag list
Returns:

struct – list of tags info dicts

domain.eoi.count(apikey[, opts=nil])

Count Expression Of Interest.

New in version 3.2.6.

Parameters:
Returns:

int – Number of EOI

domain.eoi.create(apikey, domain)

Create an Expression Of Interest for a given domain.

Expression Of Interest is a reservation for a domain in a new tld that is not available yet (e.g. gTLD).

New in version 3.2.6.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
Returns:

struct – an EOI

domain.eoi.delete(apikey, domain)

Delete an Expression Of Interest for a given domain.

New in version 3.2.6.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
Returns:

boolean – 1 if success

domain.eoi.info(apikey, domain)

Get Expression Of Interest informations for a given domain.

New in version 3.2.6.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
Returns:

struct – an EOI

domain.eoi.list(apikey[, opts=nil])

List Expressions Of Interest.

New in version 3.2.6.

Parameters:
Returns:

struct – an EOI

domain.autorenew.activate(apikey, domain[, params=nil])

Activate the autorenewal functionality for a domain.

New in version 3.1.7.

Changed in version 3.3.0: added optional parameters for duration

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • params (struct) – Parameters
Returns:

struct – Autorenew Information

domain.autorenew.deactivate(apikey, domain)

Deactivate the autorenewal functionality for a domain.

New in version 3.1.7.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
Returns:

struct – Autorenew Information

domain.claims.accept(apikey, notice_id)

Accept a specific claims notice

Warning

you must forward the information provided by the info() method to your end customer to inform them that the domain name in question is subject to a trademark claim.

Warning

acceptations are only valid until the notice expires (about 48h)

New in version 3.3.11.

Parameters:
  • apikey (string) – API connection key
  • notice_id (string) – Notice ID found inside info()
Returns:

boolean – 1

domain.claims.check(apikey, domains[, force=False])

Check for potential copyright claims on domains

This method is only useful for the first 90 days of a ngtld, afterwards the results will always be negative.

Warning

some ngtlds will keep the claim check for more than 90 days, and some will keep them forever

New in version 3.3.11.

Parameters:
  • apikey (string) – API connection key
  • domains (array) – List of domain names
  • force (boolean) – Force a registry check, even if phase doesn’t match
Returns:

struct – Each domain associated with its claims status

domain.claims.info(apikey, domain)

Returns information about a trademark claims on a specific domain.

This structure contains the notice_id key needed by the accept() method.

Warning

This method will only return information for domains with an existing (and non-expired) claim notice, use the check() method first.

New in version 3.3.11.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – A domain name previously checked with claims.key
Returns:

struct – Information about the latest claims for this domain

domain.smd.count(apikey[, opts=nil])

Count stored SMDs

New in version 3.3.11.

Parameters:
Returns:

int – count

domain.smd.create(apikey, smd)

Create a new SMD element from a SMD file

New in version 3.3.11.

Parameters:
  • apikey (string) – API connection key
  • smd (string) – contents of a Signed Mark Data file
Returns:

struct – SMD information

domain.smd.delete(apikey, smd_id)

Delete a SMD

New in version 3.3.11.

Parameters:
  • apikey (string) – API connection key
  • smd_id (int) – ID for the SMD to delete
Returns:

nil

domain.smd.extract(apikey, smd)

Extract information from a Signed Mark Data file contents

New in version 3.3.11.

Parameters:
  • apikey (string) – API connection key
  • smd (string) – contents of a Signed Mark Data file
Returns:

struct – Domain information

domain.smd.info(apikey, smd_id)

Various information about a SMD

New in version 3.3.11.

Parameters:
  • apikey (string) – API connection key
  • smd_id (int) – ID of the SMD to return
Returns:

struct – SMD Informations

domain.smd.list(apikey[, opts=nil])

List stored SMDs

New in version 3.3.11.

Parameters:
Returns:

struct – list of matching SMD

domain.misc.dk_registrar_validation(apikey, valid_hash)
Parameters:
  • apikey (string) – API connection key
  • valid_hash (string) – The validation key
Returns:

boolean – 1 if succeed

domain.misc.ukrights(apikey, params)

Rights of registration for .uk domains

This method is related to the rights of registration for .uk domains (started on June 10th, 2014 for a period of 5 years)

For each domain, returns whether or not the contact can register the domain name, along with the reason.

Reason for a non-egibility can be one of NAME, ORGANIZATION, STREET, CITY, STATE, ZIP, COUNTRY or EMAIL

There is only one reason returned even if multiple contact properties are not matching.

Warning: this method only accepts first level .uk domains, and not second level domains (like .co.uk)

New in version 3.3.13.

Parameters:
Returns:

struct – Name of domains associated to a status

domain.delete.accept(apikey, fqdn, authcode)

Positive confirmation for the foa request.

Parameters:
  • apikey (string) – API connection key
  • fqdn (string) – The domain name.
  • authcode (string) – The code of the foa
Returns:

boolean – Status

domain.delete.available(apikey, domain)

Check if a Domain is deletable

New in version 3.3.25.

Warning

This method is restricted

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
Returns:

boolean – 1 if delete is possible

domain.delete.decline(apikey, fqdn, authcode)

Negative confirmation for the foa request.

Parameters:
  • apikey (string) – API connection key
  • fqdn (string) – The domain name.
  • authcode (string) – The code of the foa
Returns:

boolean – Status

domain.delete.info(apikey, fqdn[, authcode=nil, v5=False])

Return the infos of the transfer.

Parameters:
  • apikey (struct) – API connection key
  • fqdn (string) – The fqdn of the transfer
  • authcode (string) – The code of the foa
  • v5 (boolean) – Set to True in v5 context
Returns:

struct – Infos of the transfer

domain.delete.proceed(apikey, domain)

Delete a Domain

New in version 3.3.25.

Warning

This method is restricted

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
Returns:

struct – Operation domain_delete

domain.delete.send_foa_email(apikey, fqdn, email)

Send the FOA emails

Parameters:
  • apikey (struct) – API connection key
  • fqdn (string) – The fqdn
  • email (string) – The email address
Returns:

boolean – Status

domain.transferout.proceed(apikey, domain, command, authinfo)

Accept/Decline a domain transfer.

Parameters:
  • apikey (string) – API connection key
  • domain (string) – Name of the domain
  • command (string) – accept or decline transfer out
  • authinfo (string) – Authinfo code.
Returns:

struct – The operation.

Parameters

OperationStep

used by CertificateOperationReturn, ChangeOwnerOperationReturn, DomainCreateOperationReturn, DomainDeleteOperationReturn, DomainDnssecOperationReturn, DomainReleaseOperationReturn, DomainRenewOperationReturn, DomainRestoreOperationReturn, DomainStatusUpdateOperationReturn, HostCreateOperationReturn, HostDeleteOperationReturn, HostUpdateOperationReturn, HostingOperationReturn, NsSetOperationReturn, OperationListOptions, OperationListReturn, OperationReturn, SiteOperationReturn, TransferInOperationReturn and TransferinReturn

all operations are created in a BILL step, if they require billing. All hosting operations (as described in this documentation) are created in a WAIT state, as they do not need to be billed.
Name Description
BILL if the operation requires billing, this step means it’s currently working on billing
WAIT the billing is done, the operation is waiting to be processed.
RUN Gandi backends are currently handling the operation.
ERROR an error occurred while the operation was processing, no more processing will be performed..
DONE the operation is done, end of operation’s life, no more processing will be performed.
CANCEL the user decided to cancel the operation, no more processing will be performed.
SUPPORT the operation has failed in a way that makes it possible for our Support Team to repair and relaunch it. Our team might have to contact you in order to fix possible erroneous informations.
OperationType

used by CertificateOperationReturn, ChangeOwnerOperationReturn, DomainCreateOperationReturn, DomainDeleteOperationReturn, DomainDnssecOperationReturn, DomainReleaseOperationReturn, DomainRenewOperationReturn, DomainRestoreOperationReturn, DomainStatusUpdateOperationReturn, HostCreateOperationReturn, HostDeleteOperationReturn, HostUpdateOperationReturn, HostingOperationReturn, NsSetOperationReturn, OperationListOptions, OperationListReturn, OperationReturn, SiteOperationReturn and TransferInOperationReturn

Name Description
autofoa_create -
autofoa_delete -
autofoa_validate -
billing_automatic_credit_crea te -
billing_automatic_credit_dele te -
billing_automatic_credit_set_ active -
certificate_create -
certificate_delete -
certificate_release -
certificate_renew -
certificate_replaced -
certificate_reseller_set -
certificate_update -
contact_create -
contact_reseller_set -
contact_update -
cronflex_create -
cronflex_delete -
cronflex_update -
customized_email_update -
disk_attach -
disk_create -
disk_delete -
disk_detach -
disk_dup -
disk_pause -
disk_prepare -
disk_restore -
disk_rollback_from -
disk_unpause -
disk_update -
domainpref_create -
domainpref_delete -
domainpref_update -
domain_authinfo -
domain_autorenew -
domain_change_contact -
domain_change_owner -
domain_contact_change -
domain_create -
domain_delete -
domain_dnssec_add -
domain_dnssec_delete -
domain_dnssec_set -
domain_lock -
domain_mail_redir_add -
domain_mail_redir_del -
domain_ns_set -
domain_push -
domain_redemption -
domain_renew -
domain_reseller_set -
domain_restore -
domain_status_update -
domain_trade -
domain_transfer_in -
domain_transfer_out_ack -
domain_transfer_out_nak -
domain_transfer_reseller -
domain_unlock -
domain_update -
domain_update_contact -
domain_web_redir_add -
domain_web_redir_del -
domain_web_redir_update -
flex_activation -
flex_deactivation -
hosting_account_product_add -
hosting_account_product_remov e -
hosting_account_product_renew -
hosting_account_product_updat e -
hosting_change_owner -
hosting_credit -
hosting_migration_disk -
hosting_migration_ip -
hosting_migration_paas -
hosting_migration_vm -
host_create -
host_delete -
host_update_ip -
iface_attach -
iface_create -
iface_delete -
iface_detach -
iface_update -
ip_attach -
ip_create -
ip_delete -
ip_detach -
ip_update -
lb_create -
lb_delete -
lb_update -
mailboxv2_activate -
mailboxv2_create -
mailboxv2_deactivate -
mailboxv2_delete -
mailboxv2_patch -
mailboxv2_purge -
mailboxv2_renew -
mailboxv2_update -
mailbox_add -
mailbox_create -
mailbox_del -
mailbox_purge -
mailbox_responder_activate -
mailbox_responder_deactivate -
mailbox_update -
notification_subscription_cre ate -
notification_subscription_del ete -
paas_console -
paas_disk_create -
paas_disk_delete -
paas_disk_renew -
paas_disk_update -
paas_lock -
paas_password_update -
paas_pause -
paas_restart -
paas_unlock -
paas_vm_create -
paas_vm_delete -
paas_vm_renew -
paas_vm_update -
paas_zone_alter -
packmail_activate -
packmail_autorenew -
packmail_deactivate -
packmail_downgrade -
packmail_renew -
packmail_upgrade -
prepaid_lock -
prepaid_unlock -
reachability_resend -
reachability_unlock -
rproxy_create -
rproxy_flush -
rproxy_iaas_create -
rproxy_iaas_delete -
rproxy_iaas_pause -
rproxy_iaas_renew -
rproxy_iaas_unpause -
rproxy_iaas_update -
rproxy_iaas_zone_alter -
rproxy_server_create -
rproxy_server_delete -
rproxy_server_update -
rproxy_update -
rproxy_vhost_create -
rproxy_vhost_delete -
rproxy_vhost_ssl -
sitebuilder_create -
sitebuilder_delete -
sitebuilder_lock -
sitebuilder_pause -
sitebuilder_renew -
sitebuilder_restore -
sitebuilder_unlock -
sitebuilder_update -
sitebuilder_zone_alter -
site_account_update -
site_activate -
site_create -
site_deactivate -
site_delete -
site_host_attach -
site_host_detach -
site_lock -
site_renew -
site_undelete -
site_unlock -
site_update -
site_upgrade -
sudoer_create -
sudoer_delete -
technical_template_apply -
vlan_create -
vlan_delete -
vlan_update -
vm_agent_update -
vm_conf -
vm_console_disable -
vm_console_enable -
vm_create -
vm_delete -
vm_meta_deinstall -
vm_meta_install -
vm_owner_change -
vm_pause -
vm_reboot -
vm_release_ai -
vm_reverse_set -
vm_set_state -
vm_start -
vm_stop -
vm_trigger_create -
vm_trigger_delete -
vm_unlock -
vm_update -
vm_upgrade -
watchdog_probe_create -
watchdog_probe_delete -
watchdog_probe_update -
watchdog_trigger_create -
watchdog_trigger_delete -
watchdog_trigger_update -
WebredirType

used by DomainCreate, DomainTransfer, WebredirDescription, WebredirListOptions, WebredirReturn and WebredirUpdate

Name Description
cloak Encapsulate target url in a webpage with an HTML <frame>
http302 Redirection provide by HTTP Status 302 Moved Temporarily
http301 Redirection provide by HTTP Status 301 Moved Permanently
DomainPriceReturn

used by DomainPriceListReturn

Name Type
action string
product string
unit_price array of struct
DomainAvailableOptions

parameter of domain.available()

Name Default Type Mandatory
lang   string no
ISO-639-2 language code of the domains, required for some IDN
phase golive string no
Phase of the tld
DomainCreate

parameter of domain.create()

Changed in version 3.3.35: key webredir_type has been added.
webredir_type parameter.

Changed in version 3.2.11: keys tld_phase, eoi_id have been added.
tld_phase parameter.
eoi_id parameter.

Changed in version 3.1.9: remove deprecated key lang_id.
.

Changed in version 3.1.1: key lang_id is deprecated and will be removed in the next major release.
.

Name Default Type Mandatory
admin   string yes
Administrative contact handle
bill   string yes
Billing contact handle
duration   int yes
Registration period in years, between 1 and 10
owner   string yes
Registrant handle
tech   string yes
Technical contact handle
accept_contract True boolean no
authinfo   string no
currency   string no
enforce_premium False boolean no
must be set to true if the domain is a premium domain
eoi_id   int no
Id of an Expression Of Interest to transform
extra   struct no
lang   string no
ISO-639-2 language code of the domains, required for some IDN domains
nameservers   array of string no
List of nameservers. Gandi DNS used if omitted
nameservers_ips   struct no
for glue records only – struct associating a nameserver to a list of IP addresses
price   double no
price (without tax) of the domain in case of a premium domain. See domain.price()
smd   string no
Contents of a Signed Mark Data file (used for newgtld sunrises, tld_phase must be sunrise)
smd_id   int no
template_id   string no
template_vars   string no
tld_phase   string no
Phase of the tld
webredir   string no
Default web redirection to setup after creation
webredir_type   string no
Default web redirection type to setup after creation
zone_id   int no
Zone to set after creation
DomainListOptions

parameter of domain.count() and domain.list()

Changed in version 3.3.8: key autorenew has been added.
autorenew parameter.

Name Default Type Mandatory
<date_created   string no
<date_registry_creation   string no
<date_registry_end   string no
<date_updated   string no
>date_created   string no
>date_registry_creation   string no
>date_registry_end   string no
>date_updated   string no
admin   string no
autorenew   boolean no
bill   string no
date_created   string no
date_registry_creation   string no
date_registry_end   string no
date_updated   string no
fqdn   array of string or string no
fqdn_ulabel   array of string or string no
handle   string no
id   int no
items_per_page 100 int no
number of items returned for the pagination
owner   string no
page 0 int no
page number for pagination offset
reseller   string no
service   string no
sort_by   string no
used to sort returned items: admin, autorenew, bill, date_created, date_registry_creation, date_registry_end, date_updated, fqdn, fqdn_ulabel, handle, id, owner, reseller, service, status, tag, tech, tld, zone_id, zone_name
status   string no
tag   string no
tech   string no
tld   array of string or string no
zone_id   int no
zone_name   string no
~admin   string no
~bill   string no
~fqdn   string no
~fqdn_ulabel   string no
~owner   string no
~reseller   string no
~tech   string no
~zone_name   string no
DomainPriceOptions

parameter of domain.price()

Name Default Type Mandatory
currency   string no
Currency for the prices wanted
lang   string no
ISO-639-2 language code of the domains, required for some IDN
phase golive string no
Phase of the tld
DomainRenew

parameter of domain.renew()

Name Default Type Mandatory
current_year   int yes
The current registry end year to avoid many renew
duration   int yes
The duration (in years) of the renewal
currency   string no
enforce_premium False boolean no
price   double no
DomainRestore

parameter of domain.restore()

Name Default Type Mandatory
duration   int yes
The duration (in years) of the restore
currency   string no
enforce_premium False boolean no
price   double no
DomainServices

used by DomainListOptions

Name Description
premiumdns -
linkedzone -
mailboxv2 -
dnssec -
gandimail -
site -
webhosting -
zonecheck_nok -
parking -
custom_dns -
expired -
paas -
hold -
packmail -
certificate -
redirection -
gandilivedns -
advanceddns -
hosting -
blog -
external_dns -
gandidns -
gandipremiumdns -
DomainStatus

used by DomainListOptions

Name Description
clientHold -
clientUpdateProhibited -
clientTransferProhibited -
clientDeleteProhibited -
clientRenewProhibited -
serverHold -
pendingTransfer -
pendingCreate -
serverTransferProhibited -
serverUpdateProhibited -
serverDeleteProhibited -
SMD

parameter of domain.smd.delete() and domain.smd.info()

used by DomainCreate

TldPhase

used by DomainPriceListReturn, TLDListReturn, TLDPhaseReturn, TLDSuggestInfoReturn and TldListOptions

Name Description
eoi Expression of Interest
sunrise Open for trademark only
landrush Open to organizations
eap1 Early Access Period, phase 1 (most expensive)
eap2 Early Access Period, phase 2 (slightly less expensive)
eap3 Early Access Period, phase 3 (slightly less expensive)
eap4 … and so on, each TLD having a different set of EAPs, see domain.price() for a list for each TLD
golive Open for everyone
BusinessUnit

used by MinimalBillingContactV5

ContactType

used by ContactCreateFormDescription, ContactListOptions and MinimalBillingContactV5

Name Description
0 person
1 company
2 association
3 public body
4 reseller
Lang

used by ContactCreateFormDescription, ContactUpdateFormDescription, MinimalBillingContactV5, NotificationSubscriptionListReturn and NotificationSubscriptionParam

Name Description
en english
es spanish
fr french
zh-hans simplified chinese
zh-hant traditional chinese
Grid

parameter of catalog.list()

used by TldSuggestListFoOptions

Name Description
A -
B -
C -
D -
E -
H -
TldSuggestListFoOptions

parameter of domain.price.list() and domain.suggest.list_fo()

Name Default Type Mandatory
action   array of string or string no
Process or list of processes for which price will be computed.
currency   string no
Currency to use for the pricing.
fqdns   array of struct no
List of fqdn structures (fqdn, lang) to query.
grid   string no
Grid to apply for the pricing.
premium_golive_only False boolean no
tlds   array of string no
List of TLDs to query if no fqdns given.
MinimalBillingContactV5

used by ProductSearchOptions and TldSuggestListFoOptions

Name Default Type Mandatory
bu_id   int yes
country   string yes
city   string no
email   string no
family   string no
fax   string no
given   string no
lang   string no
mobile   string no
orgname   string no
phone   string no
state   string no
streetaddr   string no
streetaddr2   string no
type   string no
user_id   string no
vat_number   string no
zip   string no
StateCodeV5

used by MinimalBillingContactV5

Name Description
AL -
AK -
AZ -
AR -
AS -
CA -
CO -
CT -
DE -
DC -
FL -
GA -
GU -
HI -
ID -
IL -
IN -
IA -
KS -
KY -
LA -
ME -
MD -
MA -
MI -
MN -
MS -
MO -
MT -
NE -
NV -
NH -
NJ -
NM -
NY -
NC -
ND -
CM -
OH -
OK -
OR -
PA -
PR -
RI -
SC -
SD -
TN -
TT -
TX -
UT -
VT -
VA -
VI -
WA -
WV -
WI -
WY -
BC -
AB -
ON -
QC -
NB -
NS -
PE -
NL -
YK -
NT -
ACT -
NSW -
NT -
QLD -
SA -
TAS -
VIC -
WA -
AP -
AR -
AS -
CH -
GO -
HP -
JK -
KA -
KL -
MA -
MN -
MP -
OR -
TN -
TR -
UP -
WB -
SK -
MB -
AG -
AL -
AN -
AO -
AP -
AQ -
AR -
AT -
AV -
BA -
BG -
BI -
BL -
BN -
BO -
BR -
BS -
BZ -
CA -
CL -
CB -
CE -
CH -
CN -
CO -
CR -
CS -
CT -
CZ -
EN -
FC -
FE -
FG -
FI -
FR -
GE -
GO -
GR -
IM -
IS -
KR -
LE -
LC -
LI -
LO -
LT -
LU -
MC -
ME -
MI -
MN -
MO -
MS -
MT -
NA -
NO -
NU -
OT -
OR -
PA -
PC -
PD -
PE -
PG -
PI -
PR -
PT -
PU -
PV -
PZ -
PN -
PO -
RA -
RC -
RE -
RG -
RI -
RN -
RM -
RO -
SA -
SI -
SO -
SP -
SR -
SS -
SV -
TA -
TE -
TN -
TO -
TP -
TR -
TS -
TV -
UD -
VA -
VE -
VB -
VC -
VR -
VV -
VI -
VT -
RSM -
AG -
BC -
BS -
CM -
CH -
CS -
CO -
CL -
DF -
DG -
GR -
GT -
HG -
JA -
ME -
MI -
MO -
NA -
NL -
OA -
PB -
QE -
QR -
SI -
SL -
SO -
TB -
TM -
TL -
VE -
YU -
ZA -
VI -
AB -
A -
AL -
O -
AV -
BA -
PM -
B -
BU -
CC -
CA -
S -
CS -
CR -
CO -
CU -
GI -
GR -
GU -
SS -
H -
HU -
J -
C -
LO -
GC -
LE -
L -
LU -
M -
MA -
MU -
NA -
OR -
P -
PO -
SA -
TF -
SG -
SE -
SO -
T -
TE -
TO -
V -
VA -
BI -
ZA -
Z -
NU -
GR-I -
GR-A -
GR-G -
GR-C -
GR-F -
GR-D -
GR-B -
GR-M -
GR-L -
GR-J -
GR-H -
GR-E -
GR-K -
42 -
72 -
83 -
26 -
53 -
24 -
21 -
94 -
43 -
11 -
91 -
74 -
41 -
73 -
31 -
25 -
23 -
52 -
22 -
54 -
93 -
82 -
01 -
03 -
02 -
06 -
04 -
CI -
VS -
MB -
OG -
BT -
CE -
ML -
JP-23 -
JP-05 -
JP-02 -
JP-12 -
JP-38 -
JP-18 -
JP-40 -
JP-07 -
JP-21 -
JP-10 -
JP-34 -
JP-01 -
JP-28 -
JP-08 -
JP-17 -
JP-03 -
JP-37 -
JP-46 -
JP-14 -
JP-39 -
JP-43 -
JP-26 -
JP-24 -
JP-04 -
JP-45 -
JP-20 -
JP-42 -
JP-29 -
JP-15 -
JP-44 -
JP-33 -
JP-47 -
JP-27 -
JP-41 -
JP-11 -
JP-25 -
JP-32 -
JP-22 -
JP-09 -
JP-36 -
JP-13 -
JP-31 -
JP-16 -
JP-30 -
JP-06 -
JP-35 -
JP-19 -
CW -
CN -
CE -
C -
DL -
D -
G -
KY -
KE -
KK -
LS -
LM -
LD -
LH -
MP -
MH -
MN -
OY -
RN -
SO -
T -
W -
WH -
WX -
WW -
AM -
AH -
DY -
DN -
FH -
TE -
AE -
AN -
BF -
BE -
BS -
IJ -
CE -
CS -
CL -
CD -
CW -
CA -
DE -
DV -
DT -
DG -
DM -
DD -
ES -
EX -
FE -
GE -
GN -
GL -
GM -
GY -
GT -
GD -
HE -
HW -
HS -
HD -
IM -
IW -
JY -
KT -
LE -
LS -
LI -
LN -
ME -
MG -
MX -
NK -
NY -
NS -
ND -
NE -
OY -
OE -
PS -
SL -
SD -
SS -
ST -
SG -
SY -
SE -
SC -
SK -
SR -
SX -
TS -
TW -
WA -
WE -
WG -
WL -
WM -
WS -
WY -
WI -
WR -
CT -
HU -
BL -
MF -
CO -
LK -
MO -
TA -
WD -
M -
U -
YT -
BR -
CT -
GA -
GJ -
HR -
JH -
ML -
MZ -
NL -
PB -
RJ -
SK -
UT -
AN -
DN -
DD -
DL -
LD -
PY -
FM -
67 -
30 -
20 -
01 -
02 -
03 -
04 -
05 -
06 -
07 -
08 -
09 -
10 -
11 -
12 -
13 -
14 -
15 -
16 -
17 -
18 -
TG -
84 -
27 -
44 -
32 -
28 -
75 -
76 -
LND -
BNS -
BIR -
BOL -
BRD -
BUR -
CLD -
COV -
DNC -
DUD -
GAT -
KIR -
KWL -
LDS -
LIV -
MAN -
NET -
OLD -
RCH -
ROT -
SHN -
SLF -
SAW -
SFT -
SHF -
SOL -
SKP -
SND -
TAM -
TRF -
STY -
NTY -
WKF -
WLL -
WGN -
WRL -
WLV -
BKM -
CAM -
CMA -
DBY -
DEV -
DOR -
ESS -
GLS -
HAM -
HRT -
KEN -
LAN -
LEC -
LIN -
NFK -
NTH -
NTT -
OXF -
SOM -
STS -
SFK -
SRY -
WSX -
ESX -
WAR -
WOR -
NYK -
BAS -
BDF -
CBF -
WBK -
BBD -
BPL -
BMH -
BRC -
BNH -
BST -
CHW -
CHE -
CON -
DAL -
DER -
DUR -
SGC -
HAL -
HPL -
HEF -
IOW -
IOS -
KHL -
LCE -
NEL -
NLN -
LUT -
MDW -
MDB -
MIK -
NBL -
NGM -
PTE -
PLY -
POL -
POR -
RDG -
RCC -
ERY -
RUT -
SHR -
SLG -
NSM -
STH -
SOS -
STT -
STE -
SWD -
TFW -
THR -
TOB -
WRT -
WIL -
WNM -
WOK -
YOR -
ANN -
AND -
ABC -
BFS -
CCG -
DRS -
FMO -
LBC -
MEA -
MUL -
NMD -
ABE -
ABD -
ANS -
AGB -
SAY -
EAY -
NAY -
CLK -
DGY -
WDU -
EDU -
DND -
EDH -
ELS -
FAL -
FIF -
GLG -
HLD -
ORK -
ZET -
IVC -
SLK -
NLK -
WLN -
ELN -
MLN -
MRY -
PKN -
RFW -
ERW -
SCB -
STG -
BGW -
BGE -
CAY -
CRF -
CMN -
CGN -
CWY -
DEN -
FLN -
GWN -
AGY -
MTY -
MON -
NTL -
NWP -
PEM -
POW -
RCT -
SWA -
TOF -
VGL -
WRX -
LA -
MD -
TLDSuggestPriceReturn

used by TLDSuggestInfoReturn

Name Type
action string
product string
taxes struct
unit_price struct
DomainVisibility

used by TLDListReturn and TLDSuggestInfoReturn

Name Description
all The TLD is not reserved to corporate account
corporate The TLD is for corporate account only
DomainChangeOwner

parameter of changeowner.create() and domain.owner.set()

Changed in version 3.3.32: key extra has been added.
extra parameter.

Name Default Type Mandatory
admin   string yes
Administrative contact handle
bill   string yes
Billing contact handle
old_owner   string yes
Old registrant handle
owner   string yes
New registrant handle
tech   string yes
Technical contact handle
extra   struct no
Extra parameters for owner change
CountryIso

used by ContactCreateFormDescription, ContactListOptions, ContactUpdateFormDescription, DomainExtraParameters, ExtraParameters, MinimalBillingContactV5 and RelaunchOperationParameters

Name Description
AC Ascension
AD Andorra
AE United Arab Emirates
AF Afghanistan
AG Antigua and Barbuda
AI Anguilla
AL Albania
AM Armenia
AN Netherlands Antilles
AO Angola
AQ Antarctica
AR Argentina
AS American Samoa
AT Austria
AU Australia
AW Aruba
AX Aland Islands
AZ Azerbaijan
BA Bosnia and Herzegovina
BB Barbados
BD Bangladesh
BE Belgium
BF Burkina Faso
BG Bulgaria
BH Bahrain
BI Burundi
BJ Benin
BL Saint Barthelemy
BM Bermuda
BN Brunei
BO Bolivia
BQ Bonaire, Sint Eustatius and Saba
BR Brazil
BS Bahamas
BT Bhutan
BV Bouvet Island
BW Botswana
BY Belarus
BZ Belize
CA Canada
CC Islands Cocos (Keeling) Islands
CD Congo Zaire
CF Central African Republic
CG Congo
CH Switzerland
CI Ivory Coast
CK Cook Islands
CL Chile
CM Cameroon
CN China
CO Colombia
CR Costa Rica
CU Cuba
CV Cape Verde
CW Curacao
CX Christmas Island
CY Cyprus
CZ Czech Republic
DE Germany
DJ Djibouti
DK Denmark
DM Dominica
DO Dominican (Republic)
DZ Algeria
EC Ecuador
EE Estonia
EG Egypt
EH Western Sahara
ER Erytrea
ES Spain
ET Ethiopia
FI Finland
FJ Fiji
FK Falkland Islands
FM Micronesia
FO Faeroe Islands
FR France
GA Gabon
GB United Kingdom
GD Grenada
GE Georgia
GF French Guiana
GG Guernsey
GH Ghana
GI Gibraltar
GL Greenland
GM Gambia
GN Guinea
GP Guadeloupe
GQ Equatorial Guinea
GR Greece
GS South Georgia and the South Sandwich Islands
GT Guatemala
GU Guam
GW Guinea-Bissau
GY Guyana
HK Hong Kong
HM Australia Heard Island and McDonald Islands
HN Honduras
HR Croatia
HT Haiti
HU Hungary
ID Indonesia
IE Ireland
IL Israel
IM Isle of Man
IN India
IO British Indian Ocean Territory
IQ Iraq
IR Iran (Islamic Rep. of)
IS Iceland
IT Italy
JE Jersey (Islands)
JM Jamaica
JO Jordan
JP Japan
KE Kenya
KG Kyrgystan
KH Cambodia
KI Kiribati
KM Comoros
KN Saint Kitts and Nevis
KP Korea (Democratic People’s Republic of)
KR Korea (Republic of)
KW Kuwait
KY Cayman (Islands)
KZ Kazakhstan
LA Laos (People’s Democratic Republic of)
LB Lebanon
LC Saint Lucia
LI Liechstenstein
LK Sri Lanka
LR Liberia
LS Lesotho
LT Lithuania
LU Luxembourg
LV Latvia
LY Libya
MA Morocco
MC Monaco
MD Moldova
ME Montenegro
MF Saint Martin (French Part)
MG Madagascar
MH Marshall Islands
MK Macedonia (F.Y.R.O.M.)
ML Mali
MM Myanmar
MN Mongolia
MO Macao
MP Saipan
MQ Martinique
MR Mauritania
MS Montserrat
MT Malta
MU Mauritius
MV Maldives
MW Malawi
MX Mexico
MY Malaysia
MZ Mozambique
NA Namibia
NC New Caledonia
NE Niger
NF Norfolk Island
NG Nigeria
NI Nicaragua
NL Netherlands
NO Norway
NP Nepal
NR Nauru
NU Niue
NZ New Zealand
OM Oman
PA Panama
PE Peru
PF French Polynesia
PG Papua New Guinea
PH Philippines
PK Pakistan
PL Poland
PM Saint Pierre et Miquelon
PN Pitcairn
PR Puerto Rico
PS Palestine
PT Portugal
PW Palau
PY Paraguay
QA Qatar
RE Reunion
RO Romania
RS Serbia
RU Russia
RW Rwanda
SA Saudi Arabia
SB Solomon
SC Seychelles
SD Sudan
SE Sweden
SG Singapore
SH Saint Helena
SI Slovenia
SJ Svalbard and Jan Mayen
SK Slovak (Republic)
SL Sierra Leone
SM San Marino
SN Senegal
SO Somalia
SR Surinam
SS South Sudan
ST Sao Tome and Principe
SV El Salvador
SX Saint Martin (Dutch Part)
SY Syria
SZ Swaziland
TC Turks and Caicos Islands
TD Chad
TF French Southern Territories
TG Togo
TH Thailand
TJ Tajikistan (Republic of)
TK Tokelau
TL Timor-Leste
TM Turkmenistan
TN Tunisia
TO Tonga
TP East Timor
TR Turkey
TT Trinidad and Tobago
TV Tuvalu
TW Taiwan
TZ Tanzania
UA Ukraine
UG Uganda
US United States of America
UY Uruguay
UZ Uzbekistan
VA Holy See (Vatican City State)
VC Saint Vincent and the Grenadines
VE Venezuela
VG British Virgin Islands (Tortola)
VI United States Virgin Islands
VN Vietnam
VU Vanuatu
WF Wallis and Futuna
WS Western Samoa
YE Yemen (Rep. of)
YT Mayotte
ZA South Africa
ZM Zambia
ZW Zimbabwe
ZZ Equatorial Kundu
UECountryIsoCitizenShip4EU

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
AT Austria
BE Belgium
BG Bulgaria
CY Cyprus
CZ Czech Republic
DE Germany
DK Denmark
EE Estonia
ES Spain
FI Finland
FR France
GR Greece
HR Croatia
HU Hungary
IE Ireland
IS Iceland
IT Italy
LI Liechstenstein
LT Lithuania
LU Luxembourg
LV Latvia
MT Malta
NL Netherlands
NO Norway
PL Poland
PT Portugal
RO Romania
SE Sweden
SI Slovenia
SK Slovak (Republic)
AuRegistrantIdType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
ABN Australian Business Number
ACN Australian Company Number
TM Trademark
OTHER Other
CaEntityType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
bank -
credit union -
savings union -
savings company -
company -
cooperation -
cooperative -
cooprix -
corp. -
federation of mutual insurance associations -
trust -
inc. -
ltd. -
lte. -
ltee. -
mutual benefit association -
nfp -
s.a. -
commercial company -
mutual insurance company -
ulc. -
llc -
sarl -
llp -
CaLegalType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
CCO Corporation - Non-individual
CCT Canadian citizen - Individual
RES Permanent Resident of Canada - Individual
GOV Government or government entity in Canada - Non-individual
EDU Canadian Educational institution - Non-individual
ASS Canadian Unincorporated Association - Non-individual
HOP Canadian Hospital - Non-individual
PRT Partnership Registered in Canada - Non-individual
TDM Trade-mark registered in Canada (by a non-Canadian owner) - Non-individual
TRD Canadian Trade union - Non-individual
PLT Canadian Political party - Non-individual
LAM Canadian Library, Archive or Museum - Non-individual
TRS Trust established in Canada - Non-individual
ABO Aboriginal Peoples (individuals or groups) indigenous to Canada - Individual
INB Indian Band recognized by the Indian Act of Canada - Non-individual
LGR Legal Representative of a Canadian Citizen or Permanent Resident - Individual
OMK Official mark registeredin Canada - Non-individual
MAJ His Majesty the King - Non-individual
DocumentType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
CUIT Código Único de Identificación Tributaria (Unique Code for Taxpaying Identification)
CNPJ Cadastro Nacional de Pessoas Jurídicas
CPF Cadastro de Pessoas Físicas
RUT Rol Único Tributario
DomainChangeContact

parameter of domain.contacts.set()

Changed in version 3.3.23: key extra has been added.
.

Name Default Type Mandatory
admin   string no
Administrative contact handle
bill   string no
Billing contact handle
extra   struct no
tech   string no
Technical contact handle
DomainExtraParameters

used by DomainChangeContact, DomainChangeOwner, DomainCreate and DomainTransfer

Changed in version 3.3.38: keys x-vn_registrant_ident_number, x-my_passport_number, x-vn_registrant_prefix, x-dk_ident_number, x-no_ident_number, x-al_id_type, x-dk_registrant_vatid, x-vn_registrant_birth_date, x-ee_company_number, x-vn_company_number, x-xn--55qx5d_registrant_document_number, x-al_vatid, x-ax_business_number, x-sa_company_number, x-eu_country_of_citizenship, x-xn--io0a7i_registrant_document_number, x-al_id_number, x-xn--io0a7i_registrant_document_type, x-xn--fiqs8s_registrant_document_number, x-ax_id_number, x-fi_birthdate, x-cn_registrant_document_type, x-vn_registrant_job, x-dk_admin_vatid, x-zuerich_uid_number, x-xn--fiqs8s_registrant_document_type, x-ee_birthdate, x-xn--55qx5d_registrant_document_type, x-cn_registrant_document_number have been added.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.

Changed in version 3.3.37: keys x-az_admin_pp_id, x-az_registrant_pp_id, x-az_billing_pp_id, x-rs_company_number, x-it_nationality, x-az_registrant_company_number, x-tw_company_number, x-lt_registrant_legal_id, x-az_tech_pp_id have been added.
x-az_admin_pp_id parameter.
x-az_registrant_pp_id parameter.
x-az_billing_pp_id parameter.
.
x-it_nationality parameter.
x-az_registrant_company_number parameter.
.
x-lt_registrant_legal_id parameter.
x-az_tech_pp_id parameter.

Changed in version 3.3.36: keys x-uk_co_no, x-hr_non_eu_pm_business_number, x-it_registrant_entity_type, x-hr_ident_number, x-uk_contact_type have been added.
x-uk_co_no parameter.
.
x-it_registrant_entity_type parameter.
.
x-uk_contact_type parameter.

Changed in version 3.3.35: keys x-pt_tech_vatid, x-fi_isfinish, x-pt_admin_vatid, x-fi_organization_type have been added.
x-pt_tech_vatid parameter.
.
x-pt_admin_vatid parameter.
.

Changed in version 3.3.32: keys x-law_accreditation_id, x-law_jurisdiction_SP, x-law_accreditation_year, x-law_accreditation_body, x-law_jurisdiction_CC have been added.
x-law_accreditation_id parameter.
x-law_jurisdiction_SP parameter.
x-law_accreditation_year parameter.
x-law_accreditation_body parameter.
x-law_jurisdiction_CC parameter.

Changed in version 3.3.29: keys x-ca_official_rep_capacity, x-ca_official_rep have been added.
x-ca_official_rep_capacity parameter.
x-ca_official_rep parameter.

Changed in version 3.3.26: key x-ca_business_entity_type has been added.
x-ca_business_entity_type parameter.

Changed in version 3.3.23: keys x-es_tech_tipo_identification, x-es_owner_identification, x-es_bill_identification, x-es_admin_identification, x-es_bill_tipo_identification, x-es_owner_legalform, x-es_admin_tipo_identification, x-es_tech_identification, x-es_owner_tipo_identification have been added.
x-es_tech_tipo_identification parameter.
x-es_owner_identification parameter.
x-es_bill_identification parameter.
x-es_admin_identification parameter.
x-es_bill_tipo_identification parameter.
x-es_owner_legalform parameter.
x-es_admin_tipo_identification parameter.
x-es_tech_identification parameter.
x-es_owner_tipo_identification paramter.

Changed in version 3.3.19: keys x-es_tipo_identification, x-es_legalform, x-es_identification have been added.
x-es_tipo_identification parameter.
x-es_legalform parameter.
x-es_identification parameter.

Name Default Type Mandatory
x-aero_ens_authid   string no
aero id (you can apply for an .aero id on http://www.information.aero/)
x-aero_ens_authkey   string no
aero password
x-al_id_number   string no
Id number used for AL registrant
x-al_id_type   string no
Type of document used for AL registrant
x-al_vatid   string no
VAT ID of AL registrant
x-au_priority_token   string no
token required to register second level .AU domains during the grandfathering period (optional)
x-au_registrant_id_number   string no
x-au_registrant_id_type   string no
owner’s document type
x-ax_business_number   string no
business ID for a Moral Person.
x-ax_id_number   string no
ID number of a Physical Person.
x-az_admin_pp_id   string no
ID number for a Physical Person admin contact
x-az_billing_pp_id   string no
ID number for a Physical Person billing contact
x-az_registrant_company_number   string no
Company number for a Moral Person registrant contact
x-az_registrant_pp_id   string no
ID number for a Physical Person registrant contact
x-az_tech_pp_id   string no
ID number for a Physical Person tech contact
x-barcelona_intendeduse   string no
Intended use for domain name
x-barcelona_trademarkid   string no
Local Trademark ID.
x-ca_business_entity_type   string no
business entity type
x-ca_legaltype   string no
owner’s legal type
x-ca_official_rep   string no
official representative (for LGR)
x-ca_official_rep_capacity   string no
official representative capacity (for LGR)
x-ca_owner_name   string no
owner name (deprecated)
x-cat_intendeduse   string no
Intended use for domain name
x-cn_registrant_document_number   string no
Associated ID / organization number for CNNIC identification, for .CN domains
x-cn_registrant_document_type   string no
Type of document used for CNNIC identification, for .CN domains
x-coop_sponsor   string no
Coop Verification Code obtained on the coop registry website (see http://www.nic.coop/preverification) (deprecated)
x-cy_reg_identity_no   string no
id card number or passport number if physical person, else registration number (SIREN)
x-dk_admin_vatid   string no
business ID for a Moral Person admin
x-dk_ident_number   string no
Danish personal identity number for individuals or companies. Individuals must match the format DDMMYY-NNNN where DD = day, MM = month, YY = century year and NNNN a 4-digits number. Companies must match the format NNNNNNNN
x-dk_registrant_vatid   string no
business ID for a Moral Person registrant
x-document_country   string no
Registrant’s country which issued the document
x-document_type   string no
Registrant’s document type
x-document_value   string no
Registrant’s document number
x-ee_birthdate   string no
Date of birth for EE physical person registrant
x-ee_company_number   string no
Company number for EE moral person registrant
x-es_admin_identification   string no
id of the admin contact
x-es_admin_tipo_identification   string no
type of id for admin
x-es_bill_identification   string no
id of the bill contact
x-es_bill_tipo_identification   string no
type of id for bill
x-es_identification   string no
id of the contact (deprecated)
x-es_legalform   string no
legal form of the organization (deprecated)
x-es_owner_identification   string no
id of the owner contact
x-es_owner_legalform   string no
legal form of the owner organization
x-es_owner_tipo_identification   string no
type of id for owner
x-es_tech_identification   string no
id of the tech contact
x-es_tech_tipo_identification   string no
type of id for tech
x-es_tipo_identification   string no
type of id (deprecated)
x-eu_country_of_citizenship   string no
Country of citizenship for registrant
x-eus_intendeduse   string no
Intended use for domain name
x-fi_birthdate   string no
Date of birth for non-FI physical person registrant
x-fi_business_number   string no
Registrant’s identification number for a moral person
x-fi_ident_number   string no
Registrant’s identification number for a physical person
x-fi_isfinish   string no
Whether or not domain registrant is Finish, for a physical or moral person
x-fi_organization_type   string no
Registrant organization type for a moral person
x-gal_intendeduse   string no
Intended use for domain name
x-hk_registrant_birth_date   string no
owner’s birth date (YYYY-MM-DD)
x-hk_registrant_document_number   string no
number of the above document
x-hk_registrant_document_origin_country   string no
country code (FR, GB, US…) of the origin country of the above document
x-hk_registrant_document_type   string no
owner’s document type
x-hk_registrant_other_document_type   string no
mandatory if x-hk_registrant_document_type is OTHIDV or OTHORG
x-hr_ident_number   string no
Croatian identification number (OIB)
x-hr_non_eu_pm_business_number   string no
Local business registration number for non european moral persons when they are a contact for a HR domain
x-hu_idnumber   string no
id card number or passport number of the physical person
x-hu_owner_vatid   string no
vatid of the moral person
x-ie_registrant_cro_number   string no
Companies Registration Office in case the registrant type ie COM
x-ie_registrant_supporting_number   string no
Identifier for a charity or a supporting number (RBN or VAT, for example) for CHA/OTH contact types (mandatory for CHA)
x-ie_registrant_type   string no
The contact’s Connection to Ireland (CTI) category that is used to indicate how the Registrant meets specific presence requirements (COM/CHA/OTH)
x-il_registrant_company_type   string no
x-it_nationality   string no
nationality of the owner
x-it_pin   string no
owner’s Italian fiscal code or the number of an identity document
x-it_registrant_entity_type   string no
owner entity type
x-jobs_website   string no
owner website information (deprecated)
x-kr_reg_identity_no   string no
Registrant’s Business Certificate No.(10-digit)/Residence Registration No.(13-digit)
x-lt_registrant_legal_id   string no
owner legal entity identification code
x-ltda_authority   string no
authority where the contact is registred
x-ltda_licensenumber   string no
licence number
x-lv_idnumber   string no
id card number or passport number if physical person, or registration number for latvian companies
x-madrid_intendeduse   string no
Intended use for domain name
x-my_admin_contact_password   string no
Admin contact password record (For transfer only)
x-my_admin_contact_username   string no
Admin contact username as per Whois record (For transfer only)
x-my_business_number   string no
Registrant’s Business Number
x-my_organization_type   string no
Registrant’s Organization Type
x-my_passport_number   string no
Registrant’s passport ID number
x-no_ident_number   string no
Norwegian personal identity number for individuals or companies. Individuals must match the format DDMMYY-NNNKK where DD = day, MM = month, YY = century year, NNN a 3-digits number and KK the first and second checksum digits to validate the number. Companies must match the format NNNNNNNNN
x-no_registrant_identity   string no
Personal identifier or organization number of the Norwegian organization (consisting of exactly 9 digits) (deprecated)
x-nu_registrant_idnumber   string no
Registrant’s id number or organization number
x-nu_registrant_vatid   string no
vatid of the moral person
x-nyc_extcontact   string no
Gandi Handle of the EXTContact
x-pro_authority   string no
authority where the contact is registred
x-pro_authoritywebsite   string no
link to the registration authority
x-pro_licensenumber   string no
licence number
x-pro_profession   string no
contact profession
x-promopixel_company_serial   string no
owner’s company serial (SIREN, SIRET, INSEE or RPPS)
x-pt_admin_vatid   string no
admin’s VAT for company or ID card number for individual
x-pt_arbitration   string no
true (default) or false as answer to whether or not the registry arbitration is accepted
x-pt_registrant_vatid   string no
owner’s VAT for company or ID card number for individual
x-pt_roid   string no
roid of the domain (in transfer process only)
x-pt_tech_vatid   string no
tech’s VAT for company or ID card number for individual
x-quebec_intendeduse   string no
Intended use for domain name
x-radio_intendeduse   string no
Intended use for domain name
x-ro_registrant_idnumber   string no
id card number or passport number if physical person, else registration number (SIREN)
x-rs_company_number   string no
The company’s number for Moral Person.
x-rs_reg_identity_no   string no
Registrant’s Residence Registration No. (13-digit)
x-rs_reg_tax_no   string no
Registrant’s GST/VAT number
x-ru_registrant_birth_date   string no
owner’s birth date (YYYY-MM-DD)
x-ru_registrant_kpp   string no
Territory-linked taxpayer number for PM registrants
x-ru_registrant_passport_data   string no
The number of the identity proof
x-ru_registrant_tin   string no
Taxpayer identification number for PM registrants
x-sa_company_number   string no
Company number for SA moral person registrant
x-scot_intendeduse   string no
Intended use for domain name
x-se_ident_number   string no
Swedish personal identity or organisational number or passport number, or id card number for individuals outside of Sweden
x-se_registrant_vatid   string no
vatid of the moral person
x-sg_idnumber   string no
Registrant’s id number
x-sport_intendeduse   string no
Intended use for domain name
x-srl_authority   string no
authority where the contact is registred
x-srl_licensenumber   string no
licence number
x-swiss_enterpriseid   string no
Swiss UID/IDE/IDI (ie. “CHE-xxx.xxx.xxx”)
x-swiss_intendeduse   string no
Intended use for domain name
x-travel_uin   string no
an Unique Identification Number (deprecated)
x-tw_company_number   string no
The company’s number for Moral Person.
x-uk_co_no   string no
The registered company number or the DfES UK school number of the registrant, mandatory for UK contact types LTD/PLC/LLP/IP/SCH/RCHAR.
x-uk_contact_type   string no
Contact type as defined at NOMINET
x-us_app_purpose   string no
Domain application purpose
x-us_nexus_category   string no
Applicant category
x-vn_company_number   string no
Moral Person company number.
x-vn_registrant_birth_date   string no
Birth date (YYYY-MM-DD) of registrant if Physical Person
x-vn_registrant_ident_number   string no
ID number of a Physical Person.
x-vn_registrant_job   string no
Registrant Job
x-vn_registrant_prefix   string no
Honorifics/personal title of Physical Person
x-xn–55qx5d_registrant_document_number   string no
Associated ID / organization number for CNNIC identification, for .xn–55qx5d
x-xn--55qx5d_registrant_document_type   string no
Type of document used for CNNIC identification, for .xn–55qx5d domains
x-xn–fiqs8s_registrant_document_number   string no
Associated ID / organization number for CNNIC identification, for .xn–fiqs8s domains
x-xn--fiqs8s_registrant_document_type   string no
Type of document used for CNNIC identification, for .xn–fiqs8s domains
x-xn–io0a7i_registrant_document_number   string no
Associated ID / organization number for CNNIC identification, for .xn–io0a7i
x-xn--io0a7i_registrant_document_type   string no
Type of document used for CNNIC identification, for .xn–io0a7i domains
x-xxx_membership_contact   string no
owner contact membership ID, obtained on the xxx registry website.
x-xxx_sponsored_community   string no
yes or no as answer to whether or not the owner is a member of the .XXX Adult Industry Sponsored Community
x-zuerich_uid_number   string no
Business Identification Number used in Switzerland (Unternehmens-Identifikationsnummer)
ESLegalform

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
1 Individual
39 Economic Interest Group
47 Association
59 Sports limited company
68 Professional Association
124 Savings Bank
150 Community Property
152 Community of Owners
164 Order or Religious Institution
181 Consulate
197 Public Law Association
203 Embassy
229 Local Authority
269 Sports Federation
286 Foundation
365 Mutual Insurance Company
434 Regional Government Body
436 Central Government Body
439 Political Party
476 Trade Union
510 Farm Partnership
524 Public Limited Company
525 Sports Association
554 Civil Society
560 General Partnership
562 General and Limited Partnership
566 Cooperative
608 Worker-owned Company
612 Limited Company
713 Spanish Office
717 Temporary Alliance of Enterprises
744 Worker-owned Limited Company
745 Regional Public Entity
746 National Public Entity
747 Local Public Entity
877 Others (only for contacts outside of Spain)
878 Designation of Origin Supervisory Council
879 Entity Managing Natural Areas
ESTipoIdent

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
0 Other ID (for contacts outside of Spain)
1 DNI and NIF (for Spanish contacts)
3 NIE for foreigners (nationality not Spanish) with legal residence
ExtraCNIDNDocumentType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

The contact type for registrants associated with xn–55qx5d, xn–io0a7i, xn–fiqs8s or cn domains All documents except Passport must be in Chinese language
Name Description
HZ Passport for foreign individuals
SFZ Chinese ID card
WJLSFZ Foreign Permanent Resident ID Card
JGZ Chinese Officer’s identity card
TWJZZ Residence permit for Taiwan residents
GAJZZ Residence permit for Hong Kong, Macao
TWJMTX Travel passes for Taiwan Residents to Enter or Leave the Mainland
GAJMTX Exit-Entry Permit for Travelling to and from Hong Kong and Macao
JWJG Overseas Organization Certificate
QT Others
YYZZ Business License
ORG Organization Code Certificate
MBFQY Private Non-Enterprise Entity Registration Certificate
SYDWFR Public Institution Legal Person Certificate
LSZY Practicing License of Law Firm
SFJD Judicial Expertise License
GZJGZY Notary Organization Practicing License
MBXXBX Private School Permit
YLJGZY Medical Institution Practicing License
SHFWJG Social Service Agency Registration Certificate
SHTTFR Social Organization Legal Person Registration Certificate
TYDM Certificate for Uniform Social Credit Code
QTTYDM Others-Certificate for Uniform Social Credit Code
JJHFR Fund Legal Person Registration Certificate
ZJCS Religion Activity Site Registration Certificate
BDDM Military Code Designation
JDDWFW Military Paid External Service License
WGCZJG Resident Representative Offices of Foreign Enterprises Registration Form
WGZHWH Registration Certificate of Foreign Cultural Center in China
WLCZJG Resident Representative Office of Tourism Departments of Foreign Government Approval Registration Certificate
BJWSXX Beijing School for Children of Foreign Embassy Staff in China Permit
FIOrganizationType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
1 Company
2 Corporation
3 Institution
4 Political party
5 Township
6 Government
7 Public community
HkOwnerDocType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
HKID Hong Kong Identity Number
OTHID Other’s Country Identity Number
PASSNO Passport No.
BIRTHCERT Birth Certificate
OTHIDV Others Individual Document
BR Business Registration Certificate
CI Certificate of Incorporation
CRS Certificate of Registration of a School
HKSARG Hong Kong Special Administrative Region Government Department
HKORDINANCE Ordinance of Hong Kong
OTHORG Others Organization Document
IERegistrantType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
COM Irish company
CHA Irish charity
OTH Other
IlRegistrantCompanyType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
INC Incorporated
LTD Limited
AB Aktiebolag
SARL Société A Responsabilité Limitée
GMBH Gesellschaft mit beschränkter Haftung
LLC Limited Liability Company
ItEntityType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
2 Italian companies / one man companies
3 Italian freelance workers / professionals
4 Italian non-profit organizations
5 Italian Public organizations
6 Other italian entities
7 Foreigners who match 2 - 6
ItRegistrantNationalityIso

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
AT Austria
BE Belgium
BG Bulgaria
CH Switzerland
CY Cyprus
CZ Czech Republic
DE Germany
DK Denmark
EE Estonia
ES Spain
FI Finland
FR France
GB United Kingdom
GR Greece
HR Croatia
HU Hungary
IE Ireland
IS Iceland
IT Italy
LI Liechstenstein
LT Lithuania
LU Luxembourg
LV Latvia
MT Malta
NL Netherlands
NO Norway
PL Poland
PT Portugal
RO Romania
SE Sweden
SI Slovenia
SK Slovak (Republic)
SM San Marino
VA Holy See (Vatican City State)
MyOrganizationType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Name Description
ota000001 architect firm
ota000002 audit firm
ota000003 business pursuant to business registration act(rob)
ota000004 business pursuant to commercial license ordinance
ota000005 company pursuant to companies act(roc)
ota000006 educational institution accredited/registered by relevant government department/agency
ota000007 farmers organisation
ota000008 federal government department or agency
ota000009 foreign embassy
ota000010 foreign office
ota000011 government aided primary and/or secondary school
ota000012 law firm
ota000013 lembaga (board)
ota000014 local authority department or agency
ota000015 maktab rendah sains mara (mrsm) under the administration of mara
ota000016 ministry of defences department or agency
ota000017 offshore company
ota000018 parents teachers association
ota000019 polytechnic under ministry of education administration
ota000020 private higher educational institution
ota000021 private school
ota000022 regional office
ota000023 religious entity
ota000024 representative office
ota000025 society pursuant to societies act(ros)
ota000026 sports organisation
ota000027 state government department or agency
ota000028 trade union
ota000029 trustee
ota000030 university under the administration of ministry of
ota000031 valuer, appraiser and estate agent firm
UKContactType

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

The contact type for contacts associated to a .uk domain

Company number (x-uk_co_no) is mandatory for types beginning with a ●

Name Description
LTD ● UK Limited Company
PLC ● UK Public Limited Company
PTNR UK Partnership
STRA UK Sole Trader
LLP ● UK Limited Liability Partnership
IP ● UK Industrial/Provident Registered Company
IND UK Individual (representing self)
SCH ● UK School
RCHAR ● UK Registered Charity
GOV UK Government Body
CRC UK Corporation by Royal Charter
STAT UK Statutory Body
OTHER UK Entity that does not fit into any of the above (e.g. clubs, associations, many universities)
FIND Non-UK Individual (representing self)
FCORP Non-UK Corporation
FOTHER Non-UK Entity that does not fit into any of the above
USAppPurpose

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Stated purpose for the registration of an US domain
Name Description
P1 Business use for profit.
P2 Non-profit business, club, association, religious organization…
P3 Personal use.
P4 Education purposes.
P5 Government purposes.
USNexusCategory

used by DomainExtraParameters, ExtraParameters and RelaunchOperationParameters

Category of the entity applying for registration of an US domain
Name Description
C11 A natural person who is a United States citizen.
C12 A natural person who is a permanent resident of the United States
C21 An entity or organization that has a bona fide presence in
C31 An entity or organization that regularly engages in lawful
C32 An entity or organization that has an office or other facility
WebredirDescription

parameter of domain.webredir.create()

Name Default Type Mandatory
host   string yes
Source of the redirection
url   string yes
Target of the redirection
type   string no
Redirection type
WebredirListOptions

parameter of domain.webredir.count() and domain.webredir.list()

Name Default Type Mandatory
host   string no
items_per_page 100 int no
number of items returned for the pagination
page 0 int no
page number for pagination offset
sort_by   string no
used to sort returned items: host, type, url
type   string no
url   string no
~host   string no
~host_or_url   string no
~url   string no
WebredirUpdate

parameter of domain.webredir.update()

Name Default Type Mandatory
host   string no
Source of the redirection
type   string no
Redirection type
url   string no
Target of the redirection
HostListOptions

parameter of domain.host.count() and domain.host.list()

Name Default Type Mandatory
ip   string no
items_per_page 100 int no
number of items returned for the pagination
name   string no
page 0 int no
page number for pagination offset
sort_by   string no
used to sort returned items: ip, name
~name   string no
MailboxCreate

parameter of domain.mailbox.create()

Name Default Type Mandatory
password   string yes
String or hashed password in sha512-crypt (ie: {SHA512-CRYPT}$6$xxxx$yyyy)
fallback_email   string no
quota   int no
MailboxListOptions

parameter of domain.mailbox.count() and domain.mailbox.list()

Name Default Type Mandatory
items_per_page 100 int no
number of items returned for the pagination
login   string no
page 0 int no
page number for pagination offset
sort_by   string no
used to sort returned items: login
~login   string no
MailboxUpdate

parameter of domain.mailbox.update()

Name Default Type Mandatory
fallback_email   string no
password   string no
String or hashed password in sha512-crypt (ie: {SHA512-CRYPT}$6$xxxx$yyyy)
quota   int no
ActivateResponder

parameter of domain.mailbox.responder.activate()

Name Default Type Mandatory
content   string yes
date   string no
DeactivateResponder

parameter of domain.mailbox.responder.deactivate()

Name Default Type Mandatory
date   string no
ForwardDescription

parameter of domain.forward.create() and domain.forward.update()

Name Default Type Mandatory
destinations   array of string yes
api-version 3 string no
ForwardListOptions

parameter of domain.forward.count() and domain.forward.list()

Name Default Type Mandatory
destination   string no
items_per_page 1000 int no
number of items returned for the pagination
page 0 int no
page number for pagination offset
sort_by   string no
used to sort returned items: destination, source
source   string no
~destination   string no
~source   string no
~source_or_destination   string no
PackmailAutorenew

parameter of domain.packmail.autorenew()

Name Default Type Mandatory
active   boolean yes
duration   int no
PackmailCreate

parameter of domain.packmail.create()

Name Default Type Mandatory
duration   int yes
forward_quota   int yes
The limit to the number of forwards
mailbox_quota   int yes
The limit to the number of mailboxes
storage_quota   int yes
The storage limit, in Go
PackmailRenew

parameter of domain.packmail.renew()

Name Default Type Mandatory
duration   int yes
accept_contract True boolean no
PackmailStatus

used by PackmailReturn

Name Description
paid paid
free free
PackmailUpdate

parameter of domain.packmail.update()

Name Default Type Mandatory
storage_quota   int yes
The storage limit, in Go
accept_contract True boolean no
TLDPhaseReturn

used by TLDListReturn

Name Type
date_end dateTime.iso8601
date_start dateTime.iso8601
date_start_gandi dateTime.iso8601
phase string
TldCategory

used by TldListOptions

Name Description
gtld -
cctld -
gTLD -
ccTLD -
TldListOptions

parameter of domain.tld.list() and domain.tld.region()

Changed in version 3.1.5: key visibility has been added.
visibility parameter.

Name Default Type Mandatory
category   string no
items_per_page 1500 int no
number of items returned for the pagination
name_ulabel   array of string or string no
page 0 int no
page number for pagination offset
phase golive string no
sort_by name string no
used to sort returned items: category, name_ulabel, phase, visibility
visibility mine string no
~name_ulabel   string no
TldVisibilityForCount

used by TldListOptions

Name Description
all All tld
mine Only tld you can view (default)
corporate Only corporate
public Only “all” in visibility
DomainTransfer

parameter of domain.transferin.proceed()

Changed in version 3.3.35: key add has changed.
add optional parameter webredir_type.

Changed in version 3.3.26: key version has changed.
version 2 is now default for new apikey.

Changed in version 3.3.24: key added has changed.
added optional parameters version.

Name Default Type Mandatory
admin   string yes
Administrative contact handle
bill   string yes
Billing contact handle
owner   string yes
Registrant handle
tech   string yes
Technical contact handle
accept_contract True boolean no
authinfo   string no
Authorization code
change_owner   int no
Set to 1, the transfer process will perform a change
currency   string no
duration   int no
enforce_premium False boolean no
extra   struct no
lang   string no
ISO-639-2 language code of the domains, required for some IDN
nameservers   array of string no
List of new nameservers. Current DNS used if omitted
price   double no
version   int no
Version number for the transfer process
webredir   string no
Default web redirection to setup after transfer
webredir_type   string no
Default web redirection type to setup after transfer
zone_id   int no
Zone to set after transfer
DomainTransferVersion

used by DomainTransfer

Name Description
1 legacy transfer version that expose transfer operation closer to each registry
2 new version that make a renew operation after the transfer operation for registry that don’t. Ensure the duration parameter is always applyed
NameserverIPs

used by DomainCreate and NameserversOptions

Struct associating a hostname with a list of IP addresses. For example:

{'ns1.mydomain.org': ['217.70.184.40', '2001:4b98:b:a::40']}
NameserversOptions

parameter of domain.nameservers.set()

Additional options used when setting nameservers

Changed in version 3.3.30: key date_start: has been added.
.

Changed in version 3.3.27: key override has been added.
override parameter.

Changed in version 3.3.22: key x-fi_auth_key has been added.
x-fi_auth_key parameter.

Changed in version 3.3.11: key nameservers_ips has been added.
nameservers_ips parameter.

Name Default Type Mandatory
date_start   string no
Schedule a nameserver change up to 90 days in advance (this may be approximative for Gandi’s DNS)
nameservers_ips   struct no
Used for creation of glue records, associate a server name with a list of IP addresses
old_nameservers [] array of string no
override False boolean no
The process will fail if you try to declare an existing nameserver while giving a different IP than what is already in our system. Set this parameter to 1 to bypass it.
x-fi_auth_key   string no
Authentication key (for .fi only)
zone_id   int no
zone to use, when switching to Gandi DNS. If unspecified, will use contact’s preferred zone, or default zone
ZoneID

parameter of domain.zone.clone(), domain.zone.delete(), domain.zone.info(), domain.zone.record.add(), domain.zone.record.count(), domain.zone.record.delete(), domain.zone.record.list(), domain.zone.record.set(), domain.zone.record.update(), domain.zone.set(), domain.zone.update(), domain.zone.version.count(), domain.zone.version.delete(), domain.zone.version.list(), domain.zone.version.new() and domain.zone.version.set()

used by NameserversOptions

ZoneClone

parameter of domain.zone.clone()

Name Default Type Mandatory
name   string no
ZoneCreate

parameter of domain.zone.create()

Name Default Type Mandatory
name   string yes
ZoneListOptions

parameter of domain.zone.count() and domain.zone.list()

Name Default Type Mandatory
!owner   string no
<date_updated   string no
>date_updated   string no
date_updated   string no
id   int or array of int no
items_per_page 500 int no
number of items returned for the pagination
name   string no
owner   string no
page 0 int no
page number for pagination offset
public   boolean no
sort_by   string no
used to sort returned items: date_updated, id, name, owner, public
~name   string no
ZoneUpdate

parameter of domain.zone.update()

Name Default Type Mandatory
name   string no
RecordDeleteOptions

parameter of domain.zone.record.delete()

Name Default Type Mandatory
<ttl   int no
>ttl   int no
id   int or string no
name   array of string or string no
ttl   int no
type   string no
value   array of string or string no
~name   string no
~value   string no
RecordListOptions

parameter of domain.zone.record.count() and domain.zone.record.list()

Name Default Type Mandatory
<ttl   int no
>ttl   int no
id   int or string no
items_per_page 100 int no
number of items returned for the pagination
name   array of string or string no
page 0 int no
page number for pagination offset
sort_by   string no
used to sort returned items: id, name, ttl, type, value
ttl   int no
type   string no
value   array of string or string no
~name   string no
~value   string no
RecordType

used by RecordDeleteOptions, RecordListOptions and ZoneRecord

Name Description
A IPv4 Address
AAAA IPv6 Address
CAA Certification Authority Authorization record RFC 6864
CNAME Alias to another DNS entry
LOC Location record RFC 1876
MX Mail exchanger record
NS Name Server (for child zones only)
SPF Sender Policy Framework record RFC 7208 RFC 7372
SRV Service record RFC 2782
TXT Descriptive text (custom usage)
WKS Well Known Services
RecordUpdateOptions

parameter of domain.zone.record.update()

Name Default Type Mandatory
id   int or string no
ZoneRecord

parameter of domain.zone.record.add() and domain.zone.record.update()

used by ZoneRecordSet

Name Default Type Mandatory
name   string yes
Relative name, may contain leading wildcard. @ for empty name
type   string yes
Record type.
value   string yes
Value for record. Semantics depends on the record type. Currently limited to 1024 ASCII characters. In case of TXT, each part between quotes is limited to 255 characters
ttl 10800 int no
Time to live, in seconds, between 5 minutes and 30 days
ZoneRecordSet

parameter of domain.zone.record.set()

a Bind zone as string (see RFC 1035#section-5.3) or a list of ZoneRecord

DNSCreateKey

parameter of domain.dnssec.create()

Name Default Type Mandatory
algorithm   int yes
Algorithm number, see IANA Assignments
flags   int yes
256 (ZSK) or 257 (KSK)
public_key   string yes
The base64-encoded public key
OrgaParam

parameter of domain.dnssec.create(), domain.dnssec.delete() and domain.dnssec.set()

Name Default Type Mandatory
TagListOptions

parameter of domain.tag.list()

Name Default Type Mandatory
<date_created   string no
>date_created   string no
date_created   string no
domains   array of string or string no
items_per_page 100 int no
number of items returned for the pagination
name   string no
page 0 int no
page number for pagination offset
sort_by   string no
used to sort returned items: date_created, domains, name
EOIListOptions

parameter of domain.eoi.count() and domain.eoi.list()

Name Default Type Mandatory
<date_created   string no
<position   int no
>date_created   string no
>position   int no
date_created   string no
fqdn   array of string or string no
items_per_page 100 int no
number of items returned for the pagination
page 0 int no
page number for pagination offset
position   int no
sort_by   string no
used to sort returned items: date_created, fqdn, position, tag, tld
tag   array of string or string no
tld   array of string or string no
~fqdn   string no
AutorenewActive

parameter of domain.autorenew.activate()

Name Default Type Mandatory
duration   int no
The duration (in years) of the renewal
ClaimContactReturn

used by ClaimReturn

Name Type
cc string
city string
email string
fax string
name string
org string
pc string
phone string
sp string
street string
ClaimsRequestStatus

used by ClaimsRequestReturn

Name Description
new Key created, but not yet accepted
accepted Claims has been accepted and will be sent with the domain creation command
SMDListOptions

parameter of domain.smd.count() and domain.smd.list()

Name Default Type Mandatory
<date_created   string no
<date_expire   string no
>date_created   string no
>date_expire   string no
date_created   string no
date_expire   string no
id   int or array of int no
items_per_page 100 int no
number of items returned for the pagination
labels   array of string or string no
mark_name   array of string or string no
page 0 int no
page number for pagination offset
sort_by   string no
used to sort returned items: date_created, date_expire, id, labels, mark_name, uid
uid   array of string or string no
~mark_name   string no
UKRights

parameter of domain.misc.ukrights()

Name Default Type Mandatory
domains   array of string yes
only .uk domains are allowed here (not .co.uk)
owner   string no
Contact to check, if different than API key contact
TransferOutProceedCommand

parameter of domain.transferout.proceed()

Name Description
accept Accept the transfer out
decline Refuse the transfer out

Returns

AutorenewReturn

returned by domain.autorenew.activate(), domain.autorenew.deactivate(), site.autorenew.activate() and site.autorenew.deactivate()

used by DomainReturn, PaasReturn, PackmailReturn and SiteReturn

Changed in version 3.2.7: key duration has changed.
.

Changed in version 3.1.7: key contact has been added.
.

Name Type
active boolean
autorenew status. 1 activates autorenew,
contact string
handle of the contact that activate/deactivate the autorenew
duration int
id int
product_id int
product_type_id int
ContactMinimalReturn

used by DomainContactReturn and EOIReturn

Name Type
handle string
id int
AvailableStatus

returned by domain.available()

Name Description
available Domain name available
available_reserved Domain name reserved under particular conditions
available_preorder Domain name can be pre-ordered
unavailable Domain name not available
unavailable_premium Domain name is not available
unavailable_restricted Domain name is not available (forbidden)
error_invalid Provided value is not a valid domain name
error_refused Service is temporarily down
error_timeout Service timed out, recall the method later
error_unknown Internal server error
reserved_corporate TLD for the given domain name is reserved for corporate customers
pending Result is not yet ready, recall the method later
error_eoi TLD for the given domain name is in EOI phase
error_ratelimited Too many requests where made. Note that the limit is partially dependent on the TLD
DomainContactReturn

used by DomainReturn

Name Type
admin struct
bill struct
owner struct
reseller struct
tech struct
DomainListReturn

returned by domain.list()

Changed in version 3.3.32: key authinfo_expiration_date has been added.
authinfo_expiration_date parameter.

Changed in version 3.3.27: keys date_hold_begin, date_delete have been added.
date_hold_begin parameter.
date_delete parameter.

Name Type
authinfo string
authinfo_expiration_date string
The date on which the authinfo code will be either expired at the registry or too old in our DB to be seemed secure
date_created dateTime.iso8601
The date the domain started to be handled by Gandi
date_delete dateTime.iso8601
The date on which the domain will be deleted at the registry
date_hold_begin dateTime.iso8601
The date from which the domain is held
date_registry_creation dateTime.iso8601
The creation date of the domain
date_registry_end dateTime.iso8601
The end date of the domain
date_updated dateTime.iso8601
The last update date
fqdn string
fqdn_ulabel string
The unicode label of the domain
id int
is_premium boolean
is_special_price boolean
status string
tld string
DomainPriceListReturn

returned by domain.price()

Name Type
available string
current_phase string
errors array
extension string
idn_lang boolean
name string
phases array of struct
prices struct
provided boolean
region string
subdomains array of struct
DomainReturn

returned by domain.info() and domain.zone.set()

Changed in version 3.3.36: key can_tld_lock has been added.
can_tld_lock parameter.

Changed in version 3.3.32: key authinfo_expiration_date has been added.
authinfo_expiration_date parameter.

Changed in version 3.3.27: keys date_delete, date_hold_begin have been added.
date_delete parameter.
date_hold_begin parameter.

Changed in version 3.2.1: key services has been added.
services parameter.

Changed in version 3.1.9: key autorenew has been added.
autorenew parameter.

Name Type
authinfo string
authinfo_expiration_date string
The date on which the authinfo code will be either expired at the registry or too old in our DB to be seemed secure
autorenew struct
can_tld_lock boolean
Possible to lock the domain at registry
contacts array of struct
date_created dateTime.iso8601
The date the domain started to be handled by Gandi
date_delete dateTime.iso8601
The date on which the domain will be deleted at the registry
date_hold_begin dateTime.iso8601
The date from which the domain is held
date_hold_end dateTime.iso8601
The date from which the domain can’t be renewed anymore (the domain can be restored if the registry supports redemption period otherwise the domain might be destroyed at Gandi at that date)
date_pending_delete_end dateTime.iso8601
The date from which the domain will be available after a deletion
date_registry_creation dateTime.iso8601
date_registry_end dateTime.iso8601
date_renew_begin dateTime.iso8601
The date from which the domain can be renewed
date_restore_end dateTime.iso8601
The date from which the domain can’t be restored anymore
date_updated dateTime.iso8601
The last update date
entity_id string
fqdn string
fqdn_ulabel string
id int
is_premium boolean
is_special_price boolean
nameservers array
services array
list associated Gandi services used on that domain
status string
tags array of struct
tld string
zone_id int
SLDReturn

used by DomainPriceListReturn and TLDSuggestInfoReturn

Name Type
description string
name string
TLDPhaseReturn

used by DomainPriceListReturn and TLDSuggestInfoReturn

Name Type
date_end dateTime.iso8601
date_start dateTime.iso8601
date_start_gandi dateTime.iso8601
phase string
DomainCreateOperationReturn

returned by domain.create()

Name Type
date_created dateTime.iso8601
date_start dateTime.iso8601
date_updated dateTime.iso8601
errortype struct
classification of the error cause if the operation is in error (possible values for errortype defined behind)
eta int
estimated time of processing the operation
id int
infos array of struct
last_error string
last error of the operation
last_support_error string
last “support” error of the operation (that should be handled manually by the support team)
params struct
session_id int
session number for the operation
source string
contact who create the operation
step string
current step of the operation
type string
Possible Errors
Error identifier Type
authorization_error support_recoverable
An authorization error happened
domain_create host_not_found
Host not found at the registry
domain_create:application_already_submitted fatal
Application already submitted for this operation.
domain_create:application_information_missing support_recoverable
Unable to retrieve application information
domain_create:application_rejected fatal
Application for the domain has been rejected
domain_create:application_sent support_recoverable
Application for the domain has been sent
domain_create:art_invalid_token client_recoverable
Use valid Pending or Registered Trademark
domain_create:au_invalid_trademark client_recoverable
Use valid Pending or Registered trademark number
domain_create:bad_application_id support_recoverable
Application for the domain has a different id at the registry
domain_create:bad_premium support_recoverable
This domain is not premium
domain_create:bad_premium_price support_recoverable
Bad premium price given in parameters
domain_create:claims_missing client_recoverable
Claims notice acceptation missing.
domain_create:contact_not_exist_registry support_recoverable
Contact doesn’t exist at registry
domain_create:contact_update_pending retryable
Domain is trying to update contacts but a previous update is pending
domain_create:domain_already_exist_db support_recoverable
Domain already exists in our database.
domain_create:domain_already_taken fatal
Domain already exists at registry
domain_create:domain_check_bad_return support_recoverable
domain:check returned an unknown response.
domain_create:domain_check_unavailable fatal
domain:check returned unavailable.
domain_create:domain_check_unavailable_eap fatal
domain:check returned unavailable:eap.
domain_create:domain_check_unavailable_premium fatal
domain:check returned unavailable:premium.
domain_create:domain_forbidden_name fatal
Reserved name - unlock code needed
domain_create:eligibility_not_active client_recoverable
Eligibility number is not Active
domain_create:host_not_found support_recoverable
Host not found at registry
domain_create:idn_multiple_scripts fatal
IDN domain with multiple scripts
domain_create:is_premium support_recoverable
Domain is premium according to registry
domain_create:missing_lang support_recoverable
Missing lang for IDN domain
domain_create:need_authcode_or_wait_landrush support_recoverable
Mail asking for authorization code has been sent, Support Agents are waiting to the answer of the customer
domain_create:not_found_at_registry support_recoverable
Domain could not be found at the registry
domain_create:nyc_extcontact_handle_not_exist support_recoverable
The handle for extcontact doesn’t exist
domain_create:order_expired fatal
The registration order could not be completed. Additional information or documents required by the registry to complete the order are missing
domain_create:pending_create support_recoverable
Still waiting for domain creation at the registry
domain_create:policy_restriction fatal
The registration order was rejected by the registry. Please check the special process to see how to obtain authorization.
domain_create:prereservation support_recoverable
A prereservation for this domain already exists
domain_create:smd_nomatch client_recoverable
SMD not match label
domain_create:smd_revoked client_recoverable
SMD is revoked
domain_create:too_few_nameservers fatal
Domain need more nameservers
domain_create:waiting_document support_recoverable
Waiting for the contact to provide registration documents
domain_create:waiting_phase_start support_recoverable
Waiting for the start of the registration phase
domain_create:waiting_premium support_recoverable
Waiting for the registration of the premium domain to be processed
domain_create:waiting_release fatal
Waiting for domain to be released
domain_dnssec:command_failed support_recoverable
Nameservers issue during domain creation
domain_dnssec:pending_transfer support_recoverable
Domain have pendingTransfer status
domain_ns_set:not_yet support_recoverable
Waiting for the domain to be declared on our NS servers
duplicate fatal
The wanted object is duplicate
missing_parameter client_recoverable
There is a missing parameter
ratelimit temporary
The query was ratelimited
timeout temporary
The query timeout
unknown unknown
Unknown
DomainReleaseOperationReturn

returned by domain.release()

Name Type
date_created dateTime.iso8601
date_start dateTime.iso8601
date_updated dateTime.iso8601
errortype struct
classification of the error cause if the operation is in error (possible values for errortype defined behind)
eta int
estimated time of processing the operation
id int
infos array of struct
last_error string
last error of the operation
last_support_error string
last “support” error of the operation (that should be handled manually by the support team)
params struct
session_id int
session number for the operation
source string
contact who create the operation
step string
current step of the operation
type string
Possible Errors
Error identifier Type
authorization_error support_recoverable
An authorization error happened
duplicate fatal
The wanted object is duplicate
missing_parameter client_recoverable
There is a missing parameter
ratelimit temporary
The query was ratelimited
timeout temporary
The query timeout
unknown unknown
Unknown
DomainRenewOperationReturn

returned by domain.renew()

Name Type
date_created dateTime.iso8601
date_start dateTime.iso8601
date_updated dateTime.iso8601
errortype struct
classification of the error cause if the operation is in error (possible values for errortype defined behind)
eta int
estimated time of processing the operation
id int
infos array of struct
last_error string
last error of the operation
last_support_error string
last “support” error of the operation (that should be handled manually by the support team)
params struct
session_id int
session number for the operation
source string
contact who create the operation
step string
current step of the operation
type string
Possible Errors
Error identifier Type
authorization_error support_recoverable
An authorization error happened
domain_renew:already_performed fatal
Operation already performed on the domain.
domain_renew:bad_premium support_recoverable
Domain is not a premium
domain_renew:bad_premium_price support_recoverable
Domain renew premium price does not match given price
domain_renew:command_failed client_recoverable
Command failed due to server error. Client should try again.
domain_renew:date_mismatch fatal
Operation already performed on the domain.
domain_renew:domain_info_unavailable_premium_to_review support_recoverable
Domain is premium at registry, Support Agent must check operation
domain_renew:domain_not_exist fatal
The domain does not exist.
domain_renew:domain_not_ours fatal
Domain is not ours at Registry.
domain_renew:err_epp support_recoverable
EPP error on the domain.renew call to registry.
domain_renew:hold_not_sync support_recoverable
Should contact registry to synchronize the hold status.
domain_renew:invalid_registry_end fatal
Invalid registry end.
domain_renew:invalid_request fatal
The request is invalid.
domain_renew:invalid_request_cat support_recoverable
The request is invalid, bad duration.
domain_renew:invalid_request_eol support_recoverable
The request is invalid, outside of renew period.
domain_renew:invalid_uin support_recoverable
The given UIN is incorect.
domain_renew:not_in_db fatal
Domain is not in our DB.
domain_renew:pending_request fatal
There is a pending operation blocking this one.
domain_renew:renew_prohibited support_recoverable
Renew is not allowed.
duplicate fatal
The wanted object is duplicate
missing_parameter client_recoverable
There is a missing parameter
ratelimit temporary
The query was ratelimited
timeout temporary
The query timeout
unknown unknown
Unknown
DomainRestoreOperationReturn

returned by domain.restore()

Name Type
date_created dateTime.iso8601
date_start dateTime.iso8601
date_updated dateTime.iso8601
errortype struct
classification of the error cause if the operation is in error (possible values for errortype defined behind)
eta int
estimated time of processing the operation
id int
infos array of struct
last_error string
last error of the operation
last_support_error string
last “support” error of the operation (that should be handled manually by the support team)
params struct
session_id int
session number for the operation
source string
contact who create the operation
step string
current step of the operation
type string
Possible Errors
Error identifier Type
authorization_error support_recoverable
An authorization error happened
domain_restore:already_restored fatal
The Domain is already restored in DB.
domain_restore:already_restored_at_registry fatal
The Domain is already restored at the registry.
domain_restore:command_failed fatal
The command failed at registry. This type of error is common for some registry providers, so we have to check the error and maybe do some regexp ?
domain_restore:domain_not_ours fatal
Domain is not ours at Registry.
domain_restore:domain_was_not_ours fatal
The Domain was not ours.
domain_restore:registry_end_differ support_recoverable
Domain ends registry differ between DB and registry. Maybe a sync command will be good enough ?
domain_restore:renew_prohibited fatal
Restore is not allowed.
domain_restore:restore_prohibited fatal
Restore is not allowed at the registry.
duplicate fatal
The wanted object is duplicate
missing_parameter client_recoverable
There is a missing parameter
ratelimit temporary
The query was ratelimited
timeout temporary
The query timeout
unknown unknown
Unknown
TLDSuggestInfoReturn

returned by domain.price.list() and domain.suggest.list_fo()

Name Type
available string
current_phase string
errors array
extension string
idn_lang boolean
name string
phases array of struct
prices struct
provided boolean
region string
subdomains array of struct
visibility string
ChangeOwnerOperationReturn

returned by changeowner.create() and domain.owner.set()

Name Type
date_created dateTime.iso8601
date_start dateTime.iso8601
date_updated dateTime.iso8601
errortype struct
classification of the error cause if the operation is in error (possible values for errortype defined behind)
eta int
estimated time of processing the operation
id int
infos array of struct
last_error string
last error of the operation
last_support_error string
last “support” error of the operation (that should be handled manually by the support team)
params struct
session_id int
session number for the operation
source string
contact who create the operation
step string
current step of the operation
type string
Possible Errors
Error identifier Type
authorization_error support_recoverable
An authorization error happened
domain_change_owner:changeowner_prohibited fatal
Change Owner is not allowed on this domain.
domain_change_owner:changeowner_refused_by_contact fatal
Negative answer(s) from contact(s).
domain_change_owner:domain_not_found fatal
Domain was not found
domain_change_owner:foa_without_answers fatal
Cannot find answers for this FOA object.
domain_change_owner:internal_error fatal
Internal error.
domain_change_owner:max_waiting_duration_reached fatal
Max waiting duration for owner responses reached.
domain_change_owner:no_foa fatal
No active FOA object found.
domain_change_owner:owner_already_changed fatal
Domain owner has changed since the operation has started
duplicate fatal
The wanted object is duplicate
missing_parameter client_recoverable
There is a missing parameter
ratelimit temporary
The query was ratelimited
timeout temporary
The query timeout
unknown unknown
Unknown
WebredirReturn

returned by domain.webredir.create(), domain.webredir.list() and domain.webredir.update()

Name Type
host string
type string
url string
DomainStatusUpdateOperationReturn

returned by domain.status.lock() and domain.status.unlock()

Name Type
date_created dateTime.iso8601
date_start dateTime.iso8601
date_updated dateTime.iso8601
errortype struct
classification of the error cause if the operation is in error (possible values for errortype defined behind)
eta int
estimated time of processing the operation
id int
infos array of struct
last_error string
last error of the operation
last_support_error string
last “support” error of the operation (that should be handled manually by the support team)
params struct
session_id int
session number for the operation
source string
contact who create the operation
step string
current step of the operation
type string
Possible Errors
Error identifier Type
authorization_error support_recoverable
An authorization error happened
domain_status_update:command_failed fatal
The command failed at registry.
domain_status_update:domain_not_ours fatal
Domain is not ours at Registry.
domain_status_update:invalid_status fatal
The domain update is prohibited.
domain_status_update:no_trustee fatal
Trustee contact has not been found in our database.
domain_status_update:policy_error fatal
Parameter Value Policy Error (2306).
domain_status_update:trustee_missing support_recoverable
Trustee contact is missing
duplicate fatal
The wanted object is duplicate
missing_parameter client_recoverable
There is a missing parameter
ratelimit temporary
The query was ratelimited
timeout temporary
The query timeout
unknown unknown
Unknown
HostListReturn

returned by domain.host.list()

Name Type
ips array
name string
HostReturn

returned by domain.host.info()

Name Type
domain string
ips array
name string
HostCreateOperationReturn

returned by domain.host.create()

Name Type
date_created dateTime.iso8601
date_start dateTime.iso8601
date_updated dateTime.iso8601
errortype struct
classification of the error cause if the operation is in error (possible values for errortype defined behind)
eta int
estimated time of processing the operation
id int
infos array of struct
last_error string
last error of the operation
last_support_error string
last “support” error of the operation (that should be handled manually by the support team)
params struct
session_id int
session number for the operation
source string
contact who create the operation
step string
current step of the operation
type string
Possible Errors
Error identifier Type
authorization_error support_recoverable
An authorization error happened
duplicate fatal
The wanted object is duplicate
host_create:command_failed fatal
The command failed at registry.
host_create:host_already_exists fatal
Host Already Exists.
host_create:host_not_found support_recoverable
Host not found at the registry.
host_create:policy_error fatal
Parameter Value Policy Error (2306).
host_create:range_error fatal
Parameter Value Range Error.
missing_parameter client_recoverable
There is a missing parameter
ratelimit temporary
The query was ratelimited
timeout temporary
The query timeout
unknown unknown
Unknown
HostDeleteOperationReturn

returned by domain.host.delete()

Name Type
date_created dateTime.iso8601
date_start dateTime.iso8601
date_updated dateTime.iso8601
errortype struct
classification of the error cause if the operation is in error (possible values for errortype defined behind)
eta int
estimated time of processing the operation
id int
infos array of struct
last_error string
last error of the operation
last_support_error string
last “support” error of the operation (that should be handled manually by the support team)
params struct
session_id int
session number for the operation
source string
contact who create the operation
step string
current step of the operation
type string
Possible Errors
Error identifier Type
authorization_error support_recoverable
An authorization error happened
duplicate fatal
The wanted object is duplicate
host_delete:association_error fatal
Association Error.
missing_parameter client_recoverable
There is a missing parameter
ratelimit temporary
The query was ratelimited
timeout temporary
The query timeout
unknown unknown
Unknown
HostUpdateOperationReturn

returned by domain.host.update()

Name Type
date_created dateTime.iso8601
date_start dateTime.iso8601
date_updated dateTime.iso8601
errortype struct
classification of the error cause if the operation is in error (possible values for errortype defined behind)
eta int
estimated time of processing the operation
id int
infos array of struct
last_error string
last error of the operation
last_support_error string
last “support” error of the operation (that should be handled manually by the support team)
params struct
session_id int
session number for the operation
source string
contact who create the operation
step string
current step of the operation
type string
Possible Errors
Error identifier Type
authorization_error support_recoverable
An authorization error happened
duplicate fatal
The wanted object is duplicate
host_update:policy_error fatal
Parameter Value Policy Error (2306).
missing_parameter client_recoverable
There is a missing parameter
ratelimit temporary
The query was ratelimited
timeout temporary
The query timeout
unknown unknown
Unknown
MailboxListReturn

returned by domain.mailbox.list()

Name Type
login string
quota struct
responder struct
MailboxQuota

used by MailboxListReturn and MailboxReturn

Name Type
granted int
Storage limit in Kio. Will be 0 when no limit is set
used string
Current storage usage in Kio
MailboxResponder

used by MailboxReturn

Name Type
active boolean
text string
MailboxResponderShort

used by MailboxListReturn

Name Type
active boolean
MailboxReturn

returned by domain.mailbox.alias.set(), domain.mailbox.create(), domain.mailbox.info() and domain.mailbox.update()

Name Type
aliases array of struct
fallback_email string
login string
quota struct
responder struct
ForwardReturn

returned by domain.forward.create(), domain.forward.list() and domain.forward.update()

Name Type
date_created dateTime.iso8601
destinations array
source string
PackmailReturn

returned by domain.packmail.info()

Changed in version 3.1.9: key autorenew has been added.
autorenew parameter.

Name Type
autorenew struct
date_created dateTime.iso8601
date_end dateTime.iso8601
domain string
domain_id int
forward_quota int
The limit to the number of forwards
id int
mailbox_quota int
The limit to the number of mailboxes
status string
storage_quota int
The storage limit, in Go
TLDListReturn

returned by domain.tld.list()

Name Type
dnssec string
id int
lock boolean
name string
name_ulabel string
phase string
phases struct
region string
visibility string
TLDRegionListReturn

returned by domain.tld.region()

dict that contain an array of tld folded by region.
Name Type
name string
region string
TransferInOperationReturn

returned by domain.transferin.proceed()

Name Type
date_created dateTime.iso8601
date_start dateTime.iso8601
date_updated dateTime.iso8601
errortype struct
eta int
id int
infos array of struct
last_error string
last_support_error string
params struct
session_id int
source string
step string
type string
Possible Errors
Error identifier Type
domain:zonecheck_failure client_recoverable
The transfer can not be finalized. The domain does not pass the registry’s zonecheck test.
domain_transferin:bad_premium support_recoverable
Domain is not a premium
domain_transferin:bad_premium_price support_recoverable
Domain transfer premium price does not match given price
domain_transferin:change_owner_mandatory client_recoverable
Owner change is mandatory on transfers for this TLD
domain_transferin:change_owner_prohibited client_recoverable
Owner change is prohibited on transfers for this TLD
domain_transferin:contact_name_parsing_failure_at_registry support_recoverable
The orgname or the fisrt name, last name of the owner couldn’t be extracted from registry contact_info (usually, it means that the contact type is bad or the firt name/orgname is missing). These infos should be corrected at the registry.
domain_transferin:domain_in_db fatal
The domain is already in the Gandi database and should be already ours.
domain_transferin:err_billing_premium_internal support_recoverable
Incorrect amount for premium operaton
domain_transferin:err_ext_billing_premium_internal fatal
Incorrect premium price
domain_transferin:foa_max_waiting_duration_reached client_recoverable
The domain’s transfer has not been accepted by the authorized
domain_transferin:internal_but_not_in_db support_recoverable
Internal transfer but not in db.
domain_transferin:internal_error support_recoverable
Internal Error.
domain_transferin:invalid_authcode client_recoverable
Invalid authcode. Change it and relaunch the operation (from ERROR to RUN step).
domain_transferin:invalid_authcode_not_match client_recoverable
Invalid authcode for internal transfer. Change it and relaunch the operation (from ERROR to RUN step).
domain_transferin:invalid_contact support_recoverable
Error on a change_contact or change_owner request. Contact at registry is obsoleted or had bad type. Disabling the contact_roid (do_not_use) to force the creation of a new contact should fix the issue.
domain_transferin:invalid_domain_datas support_recoverable
Usually an internal error from a registry provider that has some corrupted data (Ex TOO FEW ADMIN CONTACTS or TOO MANY TECH CONTACTS errors).
domain_transferin:invalid_pending_transfer client_recoverable
A transfer query is in progress but not to us.
domain_transferin:missing_param_reg_owner_handle support_recoverable
The operation parameter reg_owner_handle is missing.
domain_transferin:missing_registrar_tag support_recoverable
Registrar tag is missing in whois
domain_transferin:not_found_in_whois fatal
There is no match in Whois Database.
domain_transferin:owner_not_readable support_recoverable
Cannot read current owner at registry.
domain_transferin:provider_error support_recoverable
This is a internal error from our provider.
domain_transferin:reg_max_waiting_duration_reached support_recoverable
Max waiting duration for registry response (8 to 15 days) reached
domain_transferin:registry_domain_info_error client_recoverable
The registry failed on a domain_info, cause the authcode is invalid or the domain is Transfer Prohibited.
domain_transferin:registry_error fatal
Registry error.
domain_transferin:registry_unsupported_error fatal
The registry does not support an EPP Request.
domain_transferin:transfer_prohibited client_recoverable
The domain is marked as Transfer Prohibited at the registry or in the whois text. clientTransferProhibited and serverTransferProhibited are not ditinguished.
domain_transferin:transfer_refused client_recoverable
The registry send a negative answer to the transfer query.
domain_transferin:transfer_refused_by_contact client_recoverable
The current owner of the domain has refused the transfer query. The op can be relaunched from the start (from ERROR to WAIT)
domain_transferin:unexistant_domain fatal
The domain doesn’t exist.
domain_transferin:unrequested_transfer client_recoverable
Only for the push domains. It means that the Gandi flag couldn’t be found int the whois text.
domain_transferin:whois_extraction_error support_recoverable
The whois couldn’t be extracted for some reason (encoding problem, no whois server, the domain couldn’t be found in the whois database, etc).
domain_transferin:whois_extraction_failed client_recoverable
No email adress could have been extracted from Whois.
domain_transferin:whois_protected_flag client_recoverable
The email found in whois is a protected email.
NsSetOperationReturn

returned by domain.nameservers.set()

Name Type
date_created dateTime.iso8601
date_start dateTime.iso8601
date_updated dateTime.iso8601
errortype struct
classification of the error cause if the operation is in error (possible values for errortype defined behind)
eta int
estimated time of processing the operation
id int
infos array of struct
last_error string
last error of the operation
last_support_error string
last “support” error of the operation (that should be handled manually by the support team)
params struct
session_id int
session number for the operation
source string
contact who create the operation
step string
current step of the operation
type string
Possible Errors
Error identifier Type
authorization_error support_recoverable
An authorization error happened
domain_ns_set too_few_nameservers
fatal Need more nameservers to process
domain_ns_set:corporate_continue_with_fee support_recoverable
The operation needs to be validated by our Corporate Team.
domain_ns_set:external_issues client_recoverable
If the domain is ours, it most likely means that the customer has to create a glue record. Otherwise, the customer will have to ask the domain administrator to create the host.
domain_ns_set:host_creation_failure fatal
Failed to create host.
domain_ns_set:missing_zone fatal
Zone does not exist.
duplicate fatal
The wanted object is duplicate
missing_parameter client_recoverable
There is a missing parameter
ratelimit temporary
The query was ratelimited
timeout temporary
The query timeout
unknown unknown
Unknown
ZoneListReturn

returned by domain.zone.list()

Name Type
date_updated dateTime.iso8601
id int
name string
public boolean
version int
ZoneReturn

returned by domain.zone.clone(), domain.zone.create(), domain.zone.info() and domain.zone.update()

Changed in version 3.1.1: key public has been added.
public parameter.

Name Type
date_updated dateTime.iso8601
domains int
Number of domains linked to this zone
id int
name string
owner string
public boolean
0 custom user zone, 1 gandi generic zone
version int
id of the current active version
versions array
list all available version
ZoneVersionReturn

returned by domain.zone.version.list()

Name Type
date_created dateTime.iso8601
id int
ZoneRecordReturn

returned by domain.zone.record.add(), domain.zone.record.list(), domain.zone.record.set() and domain.zone.record.update()

Changed in version 3.3.36: key id has changed.
id is now returned as string.

Name Type
id string
name string
ttl int
type string
value string
DnssecReturn

returned by domain.dnssec.list()

Name Type
algorithm int
date_created dateTime.iso8601
digest string
digest_type int
flags int
id int
keytag int
public_key string
DomainDnssecOperationReturn

returned by domain.dnssec.create(), domain.dnssec.delete() and domain.dnssec.set()

Name Type
date_created dateTime.iso8601
date_start dateTime.iso8601
date_updated dateTime.iso8601
errortype struct
classification of the error cause if the operation is in error (possible values for errortype defined behind)
eta int
estimated time of processing the operation
id int
infos array of struct
last_error string
last error of the operation
last_support_error string
last “support” error of the operation (that should be handled manually by the support team)
params struct
session_id int
session number for the operation
source string
contact who create the operation
step string
current step of the operation
type string
Possible Errors
Error identifier Type
authorization_error support_recoverable
An authorization error happened
domain_dnssec:command_failed fatal
Nameservers issue during domain creation
domain_dnssec:command_syntax_error fatal
Command Syntax Error.
domain_dnssec:data_management_policy_violation fatal
Data Management Policy Violation.
domain_dnssec:parameter_value_policy_error support_recoverable
Parameter value policy error
domain_dnssec:parameter_value_syntax_error fatal
Parameter Value Syntax Error.
duplicate fatal
The wanted object is duplicate
missing_parameter client_recoverable
There is a missing parameter
ratelimit temporary
The query was ratelimited
timeout temporary
The query timeout
unknown unknown
Unknown
TagReturn

returned by domain.tag.add(), domain.tag.list() and domain.tag.set()

Name Type
date_created dateTime.iso8601
date_updated dateTime.iso8601
name string
EOIReturn

returned by domain.eoi.create(), domain.eoi.info() and domain.eoi.list()

Name Type
contact struct
date_created dateTime.iso8601
fqdn string
id int
max_position int
position int
tld string
ClaimReturn

used by ClaimsRequestReturn

Name Type
contacts struct
goods_and_services string
holders struct
jurisdiction_classes array
jurisdiction_country string
mark_name string
ClaimsCheckReturn

returned by domain.claims.check()

Struct mapping a domain name with its claims status (boolean)

ClaimsRequestReturn

returned by domain.claims.info()

Name Type
claims array of struct
date_created dateTime.iso8601
date_expire dateTime.iso8601
notice_id string
status string
BaseSMDReturn

returned by domain.smd.extract()

Name Type
date_expire dateTime.iso8601
labels array
mark_name string
uid string
SMDListReturn

returned by domain.smd.list()

Name Type
date_created dateTime.iso8601
date_expire dateTime.iso8601
id int
labels array
mark_id string
mark_name string
status string
uid string
SMDReturn

returned by domain.smd.create() and domain.smd.info()

Name Type
date_created dateTime.iso8601
date_expire dateTime.iso8601
id int
labels array
mark_holder_name string
mark_holder_org string
mark_id string
mark_jurisdiction string
mark_name string
mark_regnum string
original string
status string
uid string
UKRightsStatus

returned by domain.misc.ukrights()

.uk rights of registration structure
Name Type
allowed boolean
reason string
In case of non-egibility, might be one of NAME, ORGANIZATION, STREET, CITY, STATE, ZIP, COUNTRY or EMAIL
TransferinReturn

returned by domain.delete.info()

Name Type
date_created dateTime.iso8601
date_start dateTime.iso8601
date_updated dateTime.iso8601
errortype struct
id int
params struct
session_id int
source string
step string
DomainDeleteOperationReturn

returned by domain.delete.proceed()

Name Type
date_created dateTime.iso8601
date_start dateTime.iso8601
date_updated dateTime.iso8601
errortype struct
classification of the error cause if the operation is in error (possible values for errortype defined behind)
eta int
estimated time of processing the operation
id int
infos array of struct
last_error string
last error of the operation
last_support_error string
last “support” error of the operation (that should be handled manually by the support team)
params struct
session_id int
session number for the operation
source string
contact who create the operation
step string
current step of the operation
type string
Possible Errors
Error identifier Type
authorization_error support_recoverable
An authorization error happened
domain_delete:client_delete_prohibited support_recoverable
Domain registry status prevents deletion.
domain_delete:delete_refused client_recoverable
You refused to delete, cancel this operation.
domain_delete:domain_not_ours fatal
Domain is not ours at the registry.
domain_delete:foa_timeout client_recoverable
The delete FOA is more than 15 days old.
domain_delete:no_domain fatal
Could not find the domain in database.
domain_delete:no_foa fatal
This domain delete has no FOA.
domain_delete:no_foa_answers fatal
This domain delete has no FOA answers.
domain_delete:wrong_innerstep fatal
Don’t know this inner step.
duplicate fatal
The wanted object is duplicate
missing_parameter client_recoverable
There is a missing parameter
ratelimit temporary
The query was ratelimited
timeout temporary
The query timeout
unknown unknown
Unknown
OperationInformation

used by CertificateOperationReturn, ChangeOwnerOperationReturn, DomainCreateOperationReturn, DomainDeleteOperationReturn, DomainDnssecOperationReturn, DomainReleaseOperationReturn, DomainRenewOperationReturn, DomainRestoreOperationReturn, DomainStatusUpdateOperationReturn, HostCreateOperationReturn, HostDeleteOperationReturn, HostUpdateOperationReturn, NsSetOperationReturn, OperationListReturn, OperationReturn, SiteOperationReturn and TransferInOperationReturn

Name Type
extras struct
additional informations
id string
label string
name given by the user to the associated product
product_action string
associated action
product_name string
product name if available
product_type string
associated product type in the catalog
quantity string