Ordering Public Cloud projects using the OVHcloud API

Knowledge Base

Ordering Public Cloud projects using the OVHcloud API


Icons/System/eye-open Created with Sketch. 324 Views 09.12.2020 Managing billing, payments and services

Objective

Creating a project is the first step in deploying Public Cloud instances.

This guide explains how to order a Public Cloud project via the OVHcloud API.

Requirements

Instructions

Log in to the OVHcloud API interface according to the relevant guide and follow the steps below.

Step 1: Building your cart

The first step of an order is to create a 'shopping cart'. Following that you can add a Public Cloud project.

Create the cart

Use this call to create the cart:

Make sure to choose your appropriate OVHcloud API subsidiary. Take note of the cart number ("cartId") in the response; it will be required to identify this cart.

Next you will need to add a Public Cloud project as an item. Use this call with your "cartId" to verify the service availability:

In the response you can verify the parameters pertaining to a Public Cloud project:

planCode: "project.2018"

productName: "Public Cloud Project"

Add a project to the cart

Now use this call to add the item to your cart:

The following information, retrieved in the previous steps, needs to be provided:

FieldValue
cartIdID of your cart
durationP1M
planCodeproject.2018
pricingModedefault
quantity1

The response will include an "itemId" which can be used (together with the "cartId") to retrieve the cart item:

You can check the list of available configuration settings for this item with this call:

Use the following endpoint to name your project (label: "description"):

FieldValue
cartIdID of your cart
itemIdID of the item
labeldescription
valueYour project name

To apply a voucher code, use the same call with the label "voucher", etc.

The responses will include a "configurationId" which can be used (together with the "cartId" and "itemId") to retrieve the configuration (GET) or delete it, for example:

Step 2: Checking out the cart

You can verify your cart contents using the "cartId":

With the following call you can create a link to your order. It is required to first tick the relevant checkbox in order to waive the right of withdrawal.

Go further

Join our community of users.


  1. Secure Shell (SSH) : un protocole de réseau sécurisé utilisé pour établir des connexions entre un client et un serveur. Il permet d'exécuter des commandes à distance de manière sécurisée. 

Related articles