Skip to content
Console(the OVHcloud Console, opens in a new tab)

Offer

All operations require authentication.

7 operationsv1/overTheBox/availableOffers · /overTheBox/{serviceName}
OpenAPI
Agent setup

List the OverTheBox offers available to orderProduction

GET
/1.0/overTheBox/availableOffers

List the OverTheBox offers available to order. Returns the names of the offers that can be ordered for a new OverTheBox service.

Response

200OfferEnum[]successful operation

Reads your token from $OVH_TOKEN

$ curl https://api.eu.ovhcloud.com/1.0/overTheBox/availableOffers \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  "business.v1"]

List the migration offers of an OverTheBox serviceProduction

GET
/1.0/overTheBox/{serviceName}/migration/offers

List the migration offers of an OverTheBox service. Returns the offers the service can migrate to, with their price, engagement and available hardware.

Path parameters

serviceName
required
string

The internal name of your overTheBox offer

Response

200AvailableMigrationOffer[]successful operation
currentOfferPrice
Price

Monthly price of the current offer

description
string

Description of the offer

engagementMonths
integer

Number of months of engagement

hardwareAvailable
boolean

Specify if a hardware is available

hardwareName
string

Name of the hardware

hardwarePrice
Price

Hardware purchase price

hardwares
HardwareDetails[]

Details of available hardwares

offer
string

Name of the offer

price
Price

Monthly price of the new offer

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/overTheBox/{serviceName}/migration/offers \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  {    "currentOfferPrice": {      "currencyCode": "AUD",      "text": "string",      "value": 0    },    "description": "string",    "engagementMonths": 0,    "hardwareAvailable": true,    "hardwareName": "string",    "hardwarePrice": {      "currencyCode": "AUD",      "text": "string",      "value": 0    },    "hardwares": [      {        "hardwareDisplayName": "string",        "hardwareName": "string",        "hardwarePrice": {          "currencyCode": "AUD",          "text": "string",          "value": 0        }      }    ],    "offer": "string",    "price": {      "currencyCode": "AUD",      "text": "string",      "value": 0    }  }]

Migrate an OverTheBox service to another offerProduction

POST
/1.0/overTheBox/{serviceName}/migration/changeOffers

Migrate an OverTheBox service to another offer. Creates the order to migrate to the offer, with an optional hardware and shipping contact, and returns its ID and URL.

Path parameters

serviceName
required
string

The internal name of your overTheBox offer

Request body (required)

hardwareName
string

Name of the hardware

offer
required
string

Offer name to migrate to

shippingContactID
string

In case of hardware and if a shipping custom address is desired

Response

200OrderMigrationsuccessful operation
orderId
string

Id of the migration order

orderUrl
string

URL of the migration order

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/overTheBox/{serviceName}/migration/changeOffers \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "orderId": "string",  "orderUrl": "string"}

Cancel the resiliation of an OverTheBox serviceProduction

POST
/1.0/overTheBox/{serviceName}/cancelResiliation

Cancel the resiliation of an OverTheBox service. Cancels the resiliation requested on the service, which stays active.

Path parameters

serviceName
required
string

The internal name of your overTheBox offer

Response

200—successful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/overTheBox/{serviceName}/cancelResiliation \
  -H "authorization: Bearer $OVH_TOKEN"

Change service contactsProduction

POST
/1.0/overTheBox/{serviceName}/changeContact

Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.

Path parameters

serviceName
required
string

The internal name of your overTheBox offer

Request body (required)

contactAdmin
string

The contact to set as admin contact

contactBilling
string

The contact to set as billing contact

contactTech
string

The contact to set as tech contact

Response

200integer[]successful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/overTheBox/{serviceName}/changeContact \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  0]

Get service informationProduction

GET
/1.0/overTheBox/{serviceName}/serviceInfos

Get service information. Returns the status, creation and expiration dates, contacts and renewal settings of the service.

Path parameters

serviceName
required
string

The internal name of your overTheBox offer

Response

200Servicesuccessful operation
canDeleteAtExpiration
read-only
boolean

Indicates that the service can be set up to be deleted at expiration

contactAdmin
read-only
string
—
contactBilling
read-only
string
—
contactTech
read-only
string
—
creation
read-only
stringdate
—
domain
read-only
string
—
engagedUpTo
read-only
stringdate
—
expiration
read-only
stringdate
—
possibleRenewPeriod
read-only
integer[]

All the possible renew period of your service in month

renew
RenewType

Way of handling the renew

renewalType
read-only
RenewalTypeEnum

Detailed renewal type of a service

ValuesautomaticForcedProductautomaticV2012automaticV2014automaticV2016automaticV2024manualoneShotoption
serviceId
read-only
integer
—
status
read-only
StateEnum
—
ValuesautorenewInProgressexpiredinCreationokpendingDebtunPaid

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/overTheBox/{serviceName}/serviceInfos \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "canDeleteAtExpiration": true,  "contactAdmin": "string",  "contactBilling": "string",  "contactTech": "string",  "creation": "2024-01-01",  "domain": "string",  "engagedUpTo": "2024-01-01",  "expiration": "2024-01-01",  "possibleRenewPeriod": [    0  ],  "renew": {    "automatic": true,    "deleteAtExpiration": true,    "forced": true,    "manualPayment": true,    "period": 0  },  "renewalType": "automaticForcedProduct",  "serviceId": 0,  "status": "autorenewInProgress"}

Update service informationProduction

PUT
/1.0/overTheBox/{serviceName}/serviceInfos

Update service information. Updates the renewal settings of the service: automatic renewal, period, or deletion at expiration.

Path parameters

serviceName
required
string

The internal name of your overTheBox offer

Request body (required)

canDeleteAtExpiration
read-only
boolean

Indicates that the service can be set up to be deleted at expiration

contactAdmin
read-only
string
—
contactBilling
read-only
string
—
contactTech
read-only
string
—
creation
read-only
stringdate
—
domain
read-only
string
—
engagedUpTo
read-only
stringdate
—
expiration
read-only
stringdate
—
possibleRenewPeriod
read-only
integer[]

All the possible renew period of your service in month

renew
RenewType

Way of handling the renew

renewalType
read-only
RenewalTypeEnum

Detailed renewal type of a service

ValuesautomaticForcedProductautomaticV2012automaticV2014automaticV2016automaticV2024manualoneShotoption
serviceId
read-only
integer
—
status
read-only
StateEnum
—
ValuesautorenewInProgressexpiredinCreationokpendingDebtunPaid

Response

200—successful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/overTheBox/{serviceName}/serviceInfos \
  -H "authorization: Bearer $OVH_TOKEN"