Product API Reference

Warning

This API is deprecated and is going to be dropped soon The resource management is going to be replaced by Gandi credits. see also Choose a datacenter

Methods

hosting.product.create(apikey, product)

This method does nothing and will be removed in the next major release.

New in version 3.1.2.

Deprecated since version Gandi: IaaS billing is based on Gandi credits. use hosting.account.credit()

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
  • product (struct) – product to add
Returns:

struct – nil
hosting.product.delete(apikey, product_id)

This method does nothing and will be removed in the next major release.

New in version 3.1.2.

Deprecated since version Gandi: IaaS billing is based on Gandi credits. use hosting.account.credit()

Parameters:
  • apikey (string) – API connection key
  • product_id (int) – product ID to delete
Returns:

struct – nil
hosting.product.renew(apikey, product_id, product)

This method does nothing and will be removed in the next major release.

New in version 3.1.2.

Deprecated since version Gandi: IaaS billing is based on Gandi credits. use hosting.account.credit()

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
  • product_id (int) – product ID to update
  • product (struct) – product to renew
Returns:

struct – nil
hosting.product.update(apikey, product_id, product)

This method does nothing and will be removed in the next major release.

New in version 3.1.2.

Deprecated since version Gandi: IaaS billing is based on Gandi credits. use hosting.account.credit()

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
  • product_id (int) – product ID to update
  • product (struct) – product to update
Returns:

struct – nil

Parameters

ProductDescription

parameter of hosting.product.create() and product.create()

Name Default Type Mandatory
duration   string yes
1m: 1 month, 12m: 1 year
product_name   string yes
shares, cores, disk, memory, ips
quantity   int yes
ProductRenewDescription

parameter of hosting.product.renew() and product.renew()

Name Default Type Mandatory
duration   string yes
1m: 1 month, 12m: 1 year
ProductUpdateDescription

parameter of hosting.product.update() and product.update()

Name Default Type Mandatory
quantity   int yes