Operation API Reference¶

Every action on any of your resources is done by the means of an Operation.

You should use the operation.info() method to monitor the progress of your requested operation until its Step value is DONE to ensure that your operation is successfully finished.

Methods¶

operation.cancel(apikey, operation)¶

Cancel an operation.

Set the step of an operation to CANCEL.

Parameters:	apikey (string) – API connection key operation (int) – ID of the operation.
Returns:	boolean – `1`

operation.count(apikey[, opts=nil])¶

Count operations created by this contact.

Parameters:	apikey (string) – API connection key opts (struct) – `Filtering options`
Returns:	int – Number of operations

operation.count_bo(apikey[, opts=nil])¶

Works exactly like find, except it returns the count of all operations.

Parameters:	apikey (string) – API connection key opts (struct) – `Filtering options`
Returns:	int – the count of the request

operation.count_fo(apikey[, opts=nil])¶

Count operations visible by this account.

Parameters:	apikey (string) – API connection key opts (struct) – Filtering options
Returns:	int – The number of operations found.

operation.create_bo(apikey[, attributes=nil, parameters=nil])¶

Create a new operation

Parameters:	apikey (string) – API connection key attributes (struct) – `attributes of the operation` parameters (struct) – `parameters of the operation`
Returns:	struct – `created operation`

operation.delete_parameter(apikey, oper_id, key[, value=nil])¶

Delete a parameter of an operation

Parameters:	apikey (string) – API connection key oper_id (int) – id of the operation key (string) – key of the parameter value (struct) – value of the parameter
Returns:	nil

operation.get_logs(apikey, oper_id)¶

Returns the operations’ logs.

Parameters:	apikey (string) – API connection key oper_id (int) – id of the operation
Returns:	struct – `list of operations' logs`

operation.info(apikey, operation)¶

Get operation information.

Parameters:	apikey (string) – API connection key operation (int) – ID of the operation
Returns:	struct – `Operation information`

operation.info_bo(apikey, operation)¶

Get operation information.

Parameters:	apikey (string) – API connection key operation (int) – ID of the operation
Returns:	struct – `Operation information`

operation.list(apikey[, opts=nil])¶

List operations created by this contact.

Parameters:	apikey (string) – API connection key opts (struct) – `Filtering options`
Returns:	struct – `List of operations`

operation.list_bo(apikey[, opts=nil])¶

Returns the list of operations.

Parameters:	apikey (string) – API connection key opts (struct) – `Filtering options`
Returns:	struct – `list of operations`

operation.list_fo(apikey[, opts=nil])¶

Returns the list of operations.

Parameters:	apikey (string) – API connection key opts (struct) – `Filtering options`
Returns:	struct – `list of operations`

operation.relaunch(apikey, operation[, params=nil])¶

relaunch an operation.

Relaunch an operation and modify parameters.

It can be use for these types of operation: domain_create, domain_transfer_in, domain_ns_set, domain_transfer_reseller, domain_change_owner

New in version 3.1.7.

Parameters:	apikey (string) – API connection key operation (int) – ID of the operation. params (struct) – `Parameters`
Returns:	boolean – `1`

operation.update(apikey, operation[, params=nil])¶

Update operation parameters.

For the moment, only domain extra-parameters can be edited.

Parameters:	apikey (string) – API connection key operation (int) – ID of the operation params (struct) – `Parameters`
Returns:	boolean – `1`

operation.update_bo(apikey, oper_id[, attributes=nil, parameters=nil])¶

Update an operation.

Parameters:	apikey (string) – API connection key oper_id (int) – id of the operation attributes (struct) – `attributes of the operation` parameters (struct) – `parameters of the operation`
Returns:	nil

operation.update_step(apikey, operation, step[, comment=''])¶

Change the step of an operation.

Parameters:	apikey (string) – API connection key operation (int) – The ID of the operation. step (string) – The new step of the operation. comment (string) – A comment about the step change.
Returns:	nil

Parameters¶

OperParamValue¶

parameter of internal.operation.delete_parameter() and operation.delete_parameter()

GenericOperationCountFilter¶

parameter of internal.operation.count_all(), internal.operation.count(), operation.count_bo() and operation.count_fo()

Name Default Type Mandatory

filter struct no

group array of string no

GenericOperationFilter¶

parameter of internal.operation.list_all(), internal.operation.list(), operation.list_bo() and operation.list_fo()

Name Default Type Mandatory

filter struct no

group array of string no

limit int no

offset int no

order array of string no

verbose boolean no

OperationCreate¶

parameter of operation.create_bo()

Name Default Type Mandatory

type string yes

date_created string no

date_start string no

domain string no

step WAIT string no

OperationListOptions¶

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

Name Default Type Mandatory

<date_created string no

<date_start string no

<date_updated string no

>date_created string no

>date_start string no

>date_updated string no

cert.hostname string no

cert_id int or array of int no

contact_id int no

date_created string no

date_start string no

date_updated string no

disk.name string no

disk_id int no

domain string no

id int or array of int no

iface_id int no

items_per_page 100 int no

number of items returned for the pagination

mbox_id int no

paas.name string no

paas_id int no

page 0 int no

page number for pagination offset

site.name string no

site_id int no

sort_by string no

used to sort returned items: cert.hostname, cert_id, contact_id, date_created, date_start, date_updated, disk.name, disk_id, domain, id, iface_id, mbox_id, paas.name, paas_id, site.name, site_id, step, type, vm.hostname, vm_id

step string no

type string no

vm.hostname string no

vm_id int no

RelaunchOperationParameters¶

parameter of operation.relaunch()

Name Default Type Mandatory

authinfo string no

x-aero_ens_authid string no

x-aero_ens_authkey string no

x-al_id_number string no

x-al_id_type string no

x-al_vatid string no

x-au_registrant_domain_relation string no

x-au_registrant_domain_relation_type string no

x-au_registrant_id_number string no

x-au_registrant_id_type string no

x-au_registrant_organization string no

x-ax_business_number string no

x-ax_id_number string no

x-az_admin_pp_id string no

x-az_billing_pp_id string no

x-az_registrant_company_number string no

x-az_registrant_pp_id string no

x-az_tech_pp_id string no

x-barcelona_intendeduse string no

x-barcelona_trademarkid string no

x-ca_business_entity_type string no

x-ca_legaltype string no

x-ca_official_rep string no

x-ca_official_rep_capacity string no

x-ca_owner_name string no

x-cat_intendeduse string no

x-cn_registrant_document_number string no

x-cn_registrant_document_type string no

x-coop_sponsor string no

x-cy_reg_identity_no string no

x-dk_admin_vatid string no

x-dk_ident_number string no

x-dk_registrant_vatid string no

x-document_country string no

x-document_type string no

x-document_value string no

x-ee_birthdate string no

x-ee_company_number string no

x-es_admin_identification string no

x-es_admin_tipo_identification string no

x-es_bill_identification string no

x-es_bill_tipo_identification string no

x-es_identification string no

x-es_legalform string no

x-es_owner_identification string no

x-es_owner_legalform string no

x-es_owner_tipo_identification string no

x-es_tech_identification string no

x-es_tech_tipo_identification string no

x-es_tipo_identification string no

x-eu_country_of_citizenship string no

x-eus_intendeduse string no

x-fi_birthdate string no

x-fi_business_number string no

x-fi_ident_number string no

x-fi_isfinish string no

x-fi_organization_type string no

x-gal_intendeduse string no

x-hk_registrant_birth_date string no

x-hk_registrant_document_number string no

x-hk_registrant_document_origin_country string no

x-hk_registrant_document_type string no

x-hk_registrant_other_document_type string no

x-hr_ident_number string no

x-hr_non_eu_pm_business_number string no

x-hu_idnumber string no

x-hu_owner_vatid string no

x-ie_registrant_cro_number string no

x-ie_registrant_supporting_number string no

x-ie_registrant_type string no

x-il_registrant_company_type string no

x-it_nationality string no

x-it_pin string no

x-it_registrant_entity_type string no

x-jobs_website string no

x-kr_reg_identity_no string no

x-lt_registrant_legal_id string no

x-ltda_authority string no

x-ltda_licensenumber string no

x-lv_admin_idnumber string no

x-lv_idnumber string no

x-ma_id_number string no

x-ma_vatid string no

x-madrid_intendeduse string no

x-my_admin_contact_password string no

x-my_admin_contact_username string no

x-my_business_number string no

x-my_organization_type string no

x-my_passport_number string no

x-no_ident_number string no

x-no_registrant_identity string no

x-nu_registrant_idnumber string no

x-nu_registrant_vatid string no

x-nyc_extcontact string no

x-pl_company_number string no

x-pl_ident_number string no

x-pl_vatid string no

x-pro_authority string no

x-pro_authoritywebsite string no

x-pro_licensenumber string no

x-pro_profession string no

x-promopixel_company_serial string no

x-pt_registrant_vatid string no

x-pt_tech_vatid string no

x-quebec_intendeduse string no

x-radio_intendeduse string no

x-ro_registrant_idnumber string no

x-rs_company_number string no

x-rs_reg_identity_no string no

x-rs_reg_tax_no string no

x-ru_registrant_birth_date string no

x-ru_registrant_kpp string no

x-ru_registrant_passport_data string no

x-ru_registrant_tin string no

x-sa_company_number string no

x-scot_intendeduse string no

x-se_ident_number string no

x-se_registrant_vatid string no

x-sg_idnumber string no

x-sport_intendeduse string no

x-srl_authority string no

x-srl_licensenumber string no

x-swiss_enterpriseid string no

x-swiss_intendeduse string no

x-travel_uin string no

x-tw_company_number string no

x-uk_co_no string no

x-uk_contact_type string no

x-us_app_purpose string no

x-us_nexus_category string no

x-vn_company_number string no

x-vn_registrant_birth_date string no

x-vn_registrant_ident_number string no

x-vn_registrant_job string no

x-vn_registrant_prefix string no

x-xn–55qx5d_registrant_document_number string no

x-xn--55qx5d_registrant_document_type string no

x-xn–fiqs8s_registrant_document_number string no

x-xn--fiqs8s_registrant_document_type string no

x-xn–io0a7i_registrant_document_number string no

x-xn--io0a7i_registrant_document_type string no

x-xxx_membership_contact string no

x-xxx_sponsored_community string no

x-zuerich_uid_number string no

OperationInformation¶

used by InternalOperationReturn

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

DomainExtraParameters¶

parameter of operation.update()

used by DomainChangeContactStruct, DomainChangeContact, DomainChangeOwnerContactForm, DomainChangeOwner, DomainCreateContactForm, DomainCreate, DomainTransferV5 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-pl_company_number, x-pl_vatid, x-al_id_type, x-dk_registrant_vatid, x-ma_vatid, x-vn_registrant_birth_date, x-au_registrant_domain_relation_type, x-ee_company_number, x-vn_company_number, x-xn--55qx5d_registrant_document_number, x-al_vatid, x-au_registrant_id_type, x-ax_business_number, x-au_registrant_id_number, x-ma_id_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-pl_ident_number, x-au_registrant_organization, 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, x-au_registrant_domain_relation 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-pt_registrant_vatid, x-fi_isfinish, x-fi_organization_type have been added.
x-pt_tech_vatid parameter.
x-pt_registrant_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_registrant_domain_relation string no

Specify the relationship between the organization name that belongs to the registrant and domain name

x-au_registrant_domain_relation_type string no

Specify what makes the registrant eligible to register a .au, .net.au, .org.au or .com.au domain name

x-au_registrant_id_number string no

x-au_registrant_id_type string no

owner’s document type

x-au_registrant_organization string no

The organization name that belongs to the registrant

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_admin_idnumber string no

id card number or passport number mandatory for latvian physical persons

x-lv_idnumber string no

id card number or passport number for latvian physical persons, or registration number for latvian companies

x-ma_id_number string no

Id number of a physical person

x-ma_vatid string no

VAT or Businness ID of a moral person

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-pl_company_number string no

REGON number, ID of a moral person

x-pl_ident_number string no

PESEL number, ID of a physical person

x-pl_vatid string no

VAT (NIP) ID of a moral person

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_registrant_vatid string no

owner’s VAT for company or ID card number for individual

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)

Returns¶

InternalOperationReturn¶

returned by internal.operation.list_all(), internal.operation.list(), operation.list_bo() and operation.list_fo()

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 struct

last_error string

last error of the operation

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

OperationListReturn¶

returned by operation.list()

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

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

OperationLogReturn¶

returned by internal.operation.get_logs() and operation.get_logs()

Name Type

comment string

date_created dateTime.iso8601

id string

source string

type string

value string

Gandi

Table of Contents

Previous topic

Next topic

Operation API Reference¶

Methods¶

Parameters¶

Returns¶

Name	Default	Type	Mandatory
`filter`		struct	no
`group`		array of string	no

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

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`	struct
last_error	string
last error of the operation
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

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

Name	Type
comment	string
date_created	dateTime.iso8601
id	string
source	string
type	string
value	string

Gandi

Quick search

Table of Contents

Previous topic

Next topic

Operation API Reference¶

Methods¶

Parameters¶

Returns¶