Gandi

Table Of Contents

Previous topic

Gandi Operation API

Next topic

Gandi PaaS API

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:
Returns:

int – Number of operations

operation.info(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:
Returns:

struct – List of operations

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

relaunch an operation.

Relaunch an operation and modify parameters.

New in version 3.1.7.

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

boolean – 1

Parameters

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
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, 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-au_registrant_id_number   string no
x-au_registrant_id_type   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-coop_sponsor   string no
x-cy_reg_identity_no   string no
x-document_country   string no
x-document_type   string no
x-document_value   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-eus_intendeduse   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-hu_idnumber   string no
x-hu_owner_vatid   string no
x-ie_registrant_category   string no
x-ie_registrant_class   string no
x-ie_registrant_remarks   string no
x-it_pin   string no
x-it_registrant_entity_type   string no
x-kr_reg_identity_no   string no
x-law_accreditation_body   string no
x-law_accreditation_id   string no
x-law_accreditation_year   string no
x-law_jurisdiction_CC   string no
x-law_jurisdiction_SP   string no
x-ltda_authority   string no
x-ltda_licensenumber   string no
x-lv_idnumber   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-no_registrant_identity   string no
x-nu_registrant_idnumber   string no
x-nu_registrant_vatid   string no
x-nyc_extcontact   string no
x-pro_authority   string no
x-pro_authoritywebsite   string no
x-pro_licensenumber   string no
x-pro_profession   string no
x-pt_admin_vatid   string no
x-pt_arbitration   string no
x-pt_registrant_vatid   string no
x-pt_roid   string no
x-pt_tech_vatid   string no
x-quebec_intendeduse   string no
x-ro_registrant_idnumber   string no
x-rs_reg_identity_no   string no
x-rs_reg_tax_no   string no
x-ru_registrant_passport_data   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-sk_registrant_idnumber   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-xxx_membership_contact   string no
x-xxx_sponsored_community   string no

Returns

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