Products¶
Entities¶
Addon resource¶
Field |
Explanation |
|---|---|
id |
addon identificator |
products |
which products this addons is available for |
name |
addon’s name |
description |
addon’s description |
unique |
can this addon only be purchased once? |
options |
other settings |
Addon resource list:
Product resource¶
Field |
Explanation |
|---|---|
name |
Name of the product |
id |
Product identifier |
category_id |
Category identifier of the product |
description |
Description of the product |
upgrades |
Which products can this one be upgraded to |
details |
Extra information of the product |
Product resource list:
Category resource¶
Field |
Explanation |
|---|---|
id |
Category identifier |
name |
Name of the category |
Category resource list:
Template resource¶
Field |
Explanation |
|---|---|
id |
Template identifier |
name |
Name of the template |
Template resource list:
Option resource¶
Field |
Explanation |
|---|---|
option_id |
Option identifier |
description |
Description of the server |
Operations¶
Purchase New Addon¶
Product Addons¶
Account addons¶
See: Account addons
Purchase Product¶
View Account creation
List Servers for DC/VPS¶
- Method
GET
- Url
/servers
- Success Code
200
- Returned Data
- Has Token
No
List available servers for vps/dc provision
Filters:
location
List products¶
- Method
GET
- Url
/products
- Success Code
200
- Returned Data
- Has Token
No
List of products available for purchase
Filters:
category_id
Product Details¶
- Method
GET
- Url
/product/<id>
- Success Code
200
- Returned Data
- Has Token
No
Detailed view of a product.
Purchase product¶
- Method
POST
- Url
/account
- Success Code
200
- Returned Data
- Has Token
No
Parameters:
product_id. Required for any purchase.
server_id. Required for VPS and DC. Id of the server to be provisioned at. List of valid servers
template_id. Required for VPS. Id of the template to provision it. List of templates
hostname. Required for VPS. Hostname of the server.
option. Required for some licenses. List of valid options
quantity. Required for some licenses. List of valid options
Purchase addon¶
- Method
POST
- Url
/account/<id>/addon
- Success Code
200
- Returned Data
- Has Token
No
Addon list¶
- Method
GET
- Url
/addons
- Success Code
200
- Returned Data
- Has Token
No
Filters:
product_id
unique
Addon details¶
- Method
GET
- Url
/addon/<id>
- Success Code
200
- Returned Data
- Has Token
No
Product Addons¶
- Method
GET
- Url
/product/<id>/addons
- Success Code
200
- Returned Data
- Has Token
No
Get a list of available addons for a given product
Filters:
unique
Product category detail¶
- Method
GET
- Url
/category/<id>
- Success Code
200
- Returned Data
- Has Token
No
Detailed view of a category
List product categories¶
- Method
GET
- Url
/categories
- Success Code
200
- Returned Data
- Has Token
No
List categories from products
VPS Templates¶
- Method
GET
- Url
/product/<id>/templates
- Success Code
200
- Returned Data
- Has Token
No
List of templates available for vps configuration on provision.