Console Connect logo

OVHCloud

Create a new OVHCloud Connection

Prerequisites

  • Your Service key is validated with OVHCloud
  • Your company has been verified on the Console Connect platform.
Securityapi-key
Request
path Parameters
companyId
required
string

The ID of the company creating the connection.

Example: 5e4cb418ab1dbe8c8476163b
Request Body schema: application/json
required
name
required
string

The name of the new connection.

srcPortId
required
string

The source port ID.

destPortId
required
string

The destination OVH port ID.

speed
required
number

The connection speed in Mbps.

paymentType
required
string

The payment method.

Enum: "creditcard" "invoice"
duration
required
number

The duration the service was ordered for, in conjunction with durationUnit. The maximum duration by unit is: days: 6; weeks: 3; month: 36; years: 3

durationUnit
required
string

The unit of duration the service was ordered for, in conjunction with duration. 'd' for days, 'w' for weeks, 'm' for months, 'y' for years.

Enum: "d" "w" "m" "y"
partnerAccountId
required
string

The OVH account id

discountCode
string
classOfService
required
string

Name of the class of service.

Enum: "BRONZE" "SILVER" "GOLD"
evergreen
boolean
Responses
200

OK

post/app-user/{companyId}/connections/cloud/OVHCLOUD
Request samples
application/json
{
  • "partnerAccountId": "EU.81d5945e-d15f-4439-b236-1e3af7a5e014",
  • "srcPortId": "60bec23b28634d0015f872fa",
  • "paymentType": "invoice",
  • "destPortId": "645c8f1b6ae4e90015d8f53b",
  • "name": "ovh test",
  • "speed": 10,
  • "duration": 1,
  • "durationUnit": "d",
  • "classOfService": "SILVER",
  • "evergreen": true
}
Response samples
application/json
{
  • "results": {
    }
}

Post OVH Service Key Validation

Validate your OVH Service Key and recieve associated port information needed to provision a Layer 2 Connection or CloudRouter site with OVH.

Securityapi-key
Request
Request Body schema: application/json
required
serviceKey
string

Service Key provided by OVHCloud

Responses
200

OK

400

Invalid service key format

404

Service key or associated port not found

post/v2/ovh-service-key/validate
Request samples
application/json
{
  • "serviceKey": "4405543e-54a1-4b6c-920a-d574b7761645"
}
Response samples
application/json
[
  • {
    }
]
➔ Next to Internet On-Demand (IO-D)