Skip to content

Hosts

All operations require authentication.

12 operationsv1/dedicatedCloud/{serviceName}
View as Markdown (opens in a new tab)
Agent setup

List hostsProduction

GET
/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host

Path parameters

datacenterId
required
integer

Id of the Datacenter

serviceName
required
string

Domain of the service

Response

200integer[]successful operation

Example uses datacenterId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a hostProduction

GET
/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}

Get a host. Returns the host: profile, state, connection state, cluster, CPU and memory usage, and number of virtual machines.

Path parameters

datacenterId
required
integer

Id of the Datacenter

hostId
required
integer

Id of the host

serviceName
required
string

Domain of the service

Response

200Hostsuccessful operation
billingType
read-only
BillingTypeEnum

Billing type of the host

ValuesfreeSparehourlymonthlyundefined
clusterName
read-only
string

Cluster of the host

connectionState
read-only
hostSystemConnectionState

Connection state of the host

ValuesconnecteddisconnectednotResponding
cpu
read-only
UnitAndValue_double

CPU total frenquency

cpuMax
read-only
integer

The maximum speed of the cpu, in Mhz

cpuMaxCore
read-only
integer

The speed of the CPU cores. This is an average value if there are multiple speeds. in Mhz

cpuNum
read-only
integer

Number of physical CPU cores on the host.

cpuUsed
read-only
integer

Current cpu utilization, in Mhz

hostId
read-only
integer

Id of the host

inMaintenance
read-only
boolean

Host is in maintenance mode

memoryUsed
read-only
number

Amount of used memory. Sum of the memory used by all powered on virtual machines and vSphere services on the host. in MB

name
read-only
string

Name of the host (IP address)

parentHostId
read-only
integer

Id of the parent host (if any)

profile
read-only
string

Host profile in a commercial range

profileCode
read-only
string

Host profile code

rack
read-only
string

Rack of the host

ram
read-only
UnitAndValue_long

Total RAM quantity

resourceName
read-only
string

Resource name

state
read-only
StateEnum

State of the host

Valuesaddingdeliverederrorremovingunknown
uptime
read-only
integer

Host uptime in second

vmTotal
read-only
integer

Number of Virtual Machine on the host

vmVcpuTotal
read-only
integer

Number of Vcpu use by virtual machines on the host

Example uses datacenterId = 0, hostId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "billingType": "freeSpare", "clusterName": "string", "connectionState": "connected", "cpu": { "unit": "string", "value": 0 }, "cpuMax": 0, "cpuMaxCore": 0, "cpuNum": 0, "cpuUsed": 0, "hostId": 0, "inMaintenance": true, "memoryUsed": 0, "name": "string", "parentHostId": 0, "profile": "string", "profileCode": "string", "rack": "string", "ram": { "unit": "string", "value": 0 }, "resourceName": "string", "state": "adding", "uptime": 0, "vmTotal": 0, "vmVcpuTotal": 0}

Get the host consumptionDeprecated

GET
/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}/hourlyConsumption

Deprecated since May 31, 2019, will be removed on Jun 30, 2019 — use /me/consumption/usage/current instead.

Get the host consumption. Returns the hourly consumption of the host. Deprecated: use /me/consumption/usage/current instead.

Path parameters

datacenterId
required
integer

Id of the Datacenter

hostId
required
integer

Id of the host

serviceName
required
string

Domain of the service

Response

200HourlyConsumptionsuccessful operation
consumption
UnitAndValue_double

Consumption of the Host.

lastUpdate
stringdate-time

Last update.

Example uses datacenterId = 0, hostId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}/hourlyConsumption \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "consumption": { "unit": "string", "value": 0 }, "lastUpdate": "2024-01-01T12:00:00Z"}

Get the host locationProduction

GET
/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}/location

Get the host location. Returns the OVHcloud datacenter, room and rack of the host, not its vSphere datacenter.

Path parameters

datacenterId
required
integer

Id of the Datacenter

hostId
required
integer

Id of the host

serviceName
required
string

Domain of the service

Response

200Locationsuccessful operation
datacenter
DatacenterEnum

Datacenter of the Host.

Valuesbhs1bhs2bhs3bhs4bhs5bhs6bhs7bhs8cch01crx1crx2dc1eri1eri2frcrx41frcrx42frcrx43gra04gra1gra2gra3gswhdf01hil1ieb01itbsi01itmil01itzvf01lil1-int1lim1lim2lim3mr901p19rbxrbx-hzrbx1rbx10rbx2rbx3rbx4rbx5rbx6rbx7rbx8rbx9sbg1sbg2sbg3sbg4sbg5sgp02sgp1syd03syd1syd2vin1waw1ynm1yyz01
rack
string

Rack of the Host.

room
string

Room of the Host.

Example uses datacenterId = 0, hostId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}/location \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "datacenter": "bhs1", "rack": "string", "room": "string"}

Get the host resilience testProduction

GET
/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}/resilience

Path parameters

datacenterId
required
integer

Id of the Datacenter

hostId
required
integer

Id of the host

serviceName
required
string

Domain of the service

Response

200HostResiliencesuccessful operation
state
read-only
StateEnum

State of the option

Valuesdisableddisablingenabledenablingerrormigratingunknown

Example uses datacenterId = 0, hostId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}/resilience \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "state": "disabled"}

Check if a resilience test can startProduction

GET
/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}/resilience/canBeEnabled

Path parameters

datacenterId
required
integer

Id of the Datacenter

hostId
required
integer

Id of the host

serviceName
required
string

Domain of the service

Response

200booleansuccessful operation

Example uses datacenterId = 0, hostId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}/resilience/canBeEnabled \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
true

List orderable host profilesProduction

GET
/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/orderableHostProfiles

List orderable host profiles. Returns the host profiles that can be ordered in the datacenter, with their CPU, cores and RAM.

Path parameters

datacenterId
required
integer

Id of the Datacenter

serviceName
required
string

Domain of the service

Response

200Profile[]successful operation
core
string
—
cpu
UnitAndValue_double

A numeric value tagged with its unit

name
string
—
ram
UnitAndValue_long

A numeric value tagged with its unit

Example uses datacenterId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/orderableHostProfiles \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "core": "string", "cpu": { "unit": "string", "value": 0 }, "name": "string", "ram": { "unit": "string", "value": 0 } }]

Request a host replacementProduction

POST
/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}/addHostSpare

Request a host replacement. Asks for a spare host to replace this host. A reason is required. Returns a task to track progress.

Path parameters

datacenterId
required
integer

Id of the Datacenter

hostId
required
integer

Id of the host

serviceName
required
string

Domain of the service

Request body (required)

reason
required
string

Reason of spare add

Response

200Tasksuccessful operation
createdBy
read-only
string

Creator of the task

createdFrom
read-only
string

Origin of the task

datacenterId
read-only
integer

datacenterId of the associated dedicatedCloud.Datacenter object

description
read-only
string

Current progress description

endDate
read-only
stringdate-time

Task end date

executionDate
read-only
stringdate-time

Task execution date

filerId
read-only
integer

filerId of the associated dedicatedCloud.Filer object

hostId
read-only
integer

hostId of the associated dedicatedCloud.Host object

lastModificationDate
read-only
stringdate-time

Task last modification date

maintenanceDateFrom
read-only
stringdate-time

Maintenance task min allowed execution date

maintenanceDateTo
read-only
stringdate-time

Maintenance task max allowed execution date

name
read-only
string

Task name

network
read-only
string

network of the associated dedicatedCloud.Ip object

networkAccessId
read-only
integer

networkAccessId of the associated dedicatedCloud.AllowedNetwork object

orderId
read-only
integer

orderId of the associated billing.Order object

parentTaskId
read-only
integer

taskId of the parent dedicatedCloud.Task object

progress
read-only
integer

Current progress

state
read-only
TaskStateEnum

Current Task state

ValuescanceleddoingdoneerrorfixingtoCanceltoCreatetodounknownwaitingForChildswaitingTodo
taskId
read-only
integer

Task id

type
read-only
string

Task type

userId
read-only
integer

userId of the associated dedicatedCloud.User object

vlanId
read-only
integer

vlanId of the parent dedicatedCloud.Vlan object

Example uses datacenterId = 0, hostId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}/addHostSpare \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdBy": "string", "createdFrom": "string", "datacenterId": 0, "description": "string", "endDate": "2024-01-01T12:00:00Z", "executionDate": "2024-01-01T12:00:00Z", "filerId": 0, "hostId": 0, "lastModificationDate": "2024-01-01T12:00:00Z", "maintenanceDateFrom": "2024-01-01T12:00:00Z", "maintenanceDateTo": "2024-01-01T12:00:00Z", "name": "string", "network": "string", "networkAccessId": 0, "orderId": 0, "parentTaskId": 0, "progress": 0, "state": "canceled", "taskId": 0, "type": "string", "userId": 0, "vlanId": 0}

Remove a hostProduction

POST
/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}/remove

Remove a host. Removes the host from the datacenter. To replace a faulty host instead, request a spare with addHostSpare. Returns a task to track progress.

Path parameters

datacenterId
required
integer

Id of the Datacenter

hostId
required
integer

Id of the host

serviceName
required
string

Domain of the service

Response

200Tasksuccessful operation
createdBy
read-only
string

Creator of the task

createdFrom
read-only
string

Origin of the task

datacenterId
read-only
integer

datacenterId of the associated dedicatedCloud.Datacenter object

description
read-only
string

Current progress description

endDate
read-only
stringdate-time

Task end date

executionDate
read-only
stringdate-time

Task execution date

filerId
read-only
integer

filerId of the associated dedicatedCloud.Filer object

hostId
read-only
integer

hostId of the associated dedicatedCloud.Host object

lastModificationDate
read-only
stringdate-time

Task last modification date

maintenanceDateFrom
read-only
stringdate-time

Maintenance task min allowed execution date

maintenanceDateTo
read-only
stringdate-time

Maintenance task max allowed execution date

name
read-only
string

Task name

network
read-only
string

network of the associated dedicatedCloud.Ip object

networkAccessId
read-only
integer

networkAccessId of the associated dedicatedCloud.AllowedNetwork object

orderId
read-only
integer

orderId of the associated billing.Order object

parentTaskId
read-only
integer

taskId of the parent dedicatedCloud.Task object

progress
read-only
integer

Current progress

state
read-only
TaskStateEnum

Current Task state

ValuescanceleddoingdoneerrorfixingtoCanceltoCreatetodounknownwaitingForChildswaitingTodo
taskId
read-only
integer

Task id

type
read-only
string

Task type

userId
read-only
integer

userId of the associated dedicatedCloud.User object

vlanId
read-only
integer

vlanId of the parent dedicatedCloud.Vlan object

Example uses datacenterId = 0, hostId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}/remove \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdBy": "string", "createdFrom": "string", "datacenterId": 0, "description": "string", "endDate": "2024-01-01T12:00:00Z", "executionDate": "2024-01-01T12:00:00Z", "filerId": 0, "hostId": 0, "lastModificationDate": "2024-01-01T12:00:00Z", "maintenanceDateFrom": "2024-01-01T12:00:00Z", "maintenanceDateTo": "2024-01-01T12:00:00Z", "name": "string", "network": "string", "networkAccessId": 0, "orderId": 0, "parentTaskId": 0, "progress": 0, "state": "canceled", "taskId": 0, "type": "string", "userId": 0, "vlanId": 0}

Stop the resilience testProduction

POST
/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}/resilience/disable

Path parameters

datacenterId
required
integer

Id of the Datacenter

hostId
required
integer

Id of the host

serviceName
required
string

Domain of the service

Response

200Tasksuccessful operation
createdBy
read-only
string

Creator of the task

createdFrom
read-only
string

Origin of the task

datacenterId
read-only
integer

datacenterId of the associated dedicatedCloud.Datacenter object

description
read-only
string

Current progress description

endDate
read-only
stringdate-time

Task end date

executionDate
read-only
stringdate-time

Task execution date

filerId
read-only
integer

filerId of the associated dedicatedCloud.Filer object

hostId
read-only
integer

hostId of the associated dedicatedCloud.Host object

lastModificationDate
read-only
stringdate-time

Task last modification date

maintenanceDateFrom
read-only
stringdate-time

Maintenance task min allowed execution date

maintenanceDateTo
read-only
stringdate-time

Maintenance task max allowed execution date

name
read-only
string

Task name

network
read-only
string

network of the associated dedicatedCloud.Ip object

networkAccessId
read-only
integer

networkAccessId of the associated dedicatedCloud.AllowedNetwork object

orderId
read-only
integer

orderId of the associated billing.Order object

parentTaskId
read-only
integer

taskId of the parent dedicatedCloud.Task object

progress
read-only
integer

Current progress

state
read-only
TaskStateEnum

Current Task state

ValuescanceleddoingdoneerrorfixingtoCanceltoCreatetodounknownwaitingForChildswaitingTodo
taskId
read-only
integer

Task id

type
read-only
string

Task type

userId
read-only
integer

userId of the associated dedicatedCloud.User object

vlanId
read-only
integer

vlanId of the parent dedicatedCloud.Vlan object

Example uses datacenterId = 0, hostId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}/resilience/disable \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdBy": "string", "createdFrom": "string", "datacenterId": 0, "description": "string", "endDate": "2024-01-01T12:00:00Z", "executionDate": "2024-01-01T12:00:00Z", "filerId": 0, "hostId": 0, "lastModificationDate": "2024-01-01T12:00:00Z", "maintenanceDateFrom": "2024-01-01T12:00:00Z", "maintenanceDateTo": "2024-01-01T12:00:00Z", "name": "string", "network": "string", "networkAccessId": 0, "orderId": 0, "parentTaskId": 0, "progress": 0, "state": "canceled", "taskId": 0, "type": "string", "userId": 0, "vlanId": 0}

Start a resilience testProduction

POST
/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}/resilience/enable

Start a resilience test. Cuts the network access of the host for the given duration, then reconnects it: 10 minutes to 24 hours, 1 hour by default. Returns a task to track progress.

Path parameters

datacenterId
required
integer

Id of the Datacenter

hostId
required
integer

Id of the host

serviceName
required
string

Domain of the service

Request body (required)

duration
integer

Duration test in minutes. Host will be reconnected after this period (min:10min, max:24h, default:1h)

Response

200Tasksuccessful operation
createdBy
read-only
string

Creator of the task

createdFrom
read-only
string

Origin of the task

datacenterId
read-only
integer

datacenterId of the associated dedicatedCloud.Datacenter object

description
read-only
string

Current progress description

endDate
read-only
stringdate-time

Task end date

executionDate
read-only
stringdate-time

Task execution date

filerId
read-only
integer

filerId of the associated dedicatedCloud.Filer object

hostId
read-only
integer

hostId of the associated dedicatedCloud.Host object

lastModificationDate
read-only
stringdate-time

Task last modification date

maintenanceDateFrom
read-only
stringdate-time

Maintenance task min allowed execution date

maintenanceDateTo
read-only
stringdate-time

Maintenance task max allowed execution date

name
read-only
string

Task name

network
read-only
string

network of the associated dedicatedCloud.Ip object

networkAccessId
read-only
integer

networkAccessId of the associated dedicatedCloud.AllowedNetwork object

orderId
read-only
integer

orderId of the associated billing.Order object

parentTaskId
read-only
integer

taskId of the parent dedicatedCloud.Task object

progress
read-only
integer

Current progress

state
read-only
TaskStateEnum

Current Task state

ValuescanceleddoingdoneerrorfixingtoCanceltoCreatetodounknownwaitingForChildswaitingTodo
taskId
read-only
integer

Task id

type
read-only
string

Task type

userId
read-only
integer

userId of the associated dedicatedCloud.User object

vlanId
read-only
integer

vlanId of the parent dedicatedCloud.Vlan object

Example uses datacenterId = 0, hostId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/host/{hostId}/resilience/enable \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdBy": "string", "createdFrom": "string", "datacenterId": 0, "description": "string", "endDate": "2024-01-01T12:00:00Z", "executionDate": "2024-01-01T12:00:00Z", "filerId": 0, "hostId": 0, "lastModificationDate": "2024-01-01T12:00:00Z", "maintenanceDateFrom": "2024-01-01T12:00:00Z", "maintenanceDateTo": "2024-01-01T12:00:00Z", "name": "string", "network": "string", "networkAccessId": 0, "orderId": 0, "parentTaskId": 0, "progress": 0, "state": "canceled", "taskId": 0, "type": "string", "userId": 0, "vlanId": 0}

Order an hourly hostProduction

POST
/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/orderNewHostHourly

Order an hourly host. Orders a host billed by the hour with the given host profile, optionally in a given cluster. Returns a task to track progress.

Path parameters

datacenterId
required
integer

Id of the Datacenter

serviceName
required
string

Domain of the service

Request body (required)

name
required
string

Host profile you want to order

vmwareClusterId
string

Id of the cluster you want the host to be added ("domain-cXX")

Response

200Tasksuccessful operation
createdBy
read-only
string

Creator of the task

createdFrom
read-only
string

Origin of the task

datacenterId
read-only
integer

datacenterId of the associated dedicatedCloud.Datacenter object

description
read-only
string

Current progress description

endDate
read-only
stringdate-time

Task end date

executionDate
read-only
stringdate-time

Task execution date

filerId
read-only
integer

filerId of the associated dedicatedCloud.Filer object

hostId
read-only
integer

hostId of the associated dedicatedCloud.Host object

lastModificationDate
read-only
stringdate-time

Task last modification date

maintenanceDateFrom
read-only
stringdate-time

Maintenance task min allowed execution date

maintenanceDateTo
read-only
stringdate-time

Maintenance task max allowed execution date

name
read-only
string

Task name

network
read-only
string

network of the associated dedicatedCloud.Ip object

networkAccessId
read-only
integer

networkAccessId of the associated dedicatedCloud.AllowedNetwork object

orderId
read-only
integer

orderId of the associated billing.Order object

parentTaskId
read-only
integer

taskId of the parent dedicatedCloud.Task object

progress
read-only
integer

Current progress

state
read-only
TaskStateEnum

Current Task state

ValuescanceleddoingdoneerrorfixingtoCanceltoCreatetodounknownwaitingForChildswaitingTodo
taskId
read-only
integer

Task id

type
read-only
string

Task type

userId
read-only
integer

userId of the associated dedicatedCloud.User object

vlanId
read-only
integer

vlanId of the parent dedicatedCloud.Vlan object

Example uses datacenterId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/orderNewHostHourly \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdBy": "string", "createdFrom": "string", "datacenterId": 0, "description": "string", "endDate": "2024-01-01T12:00:00Z", "executionDate": "2024-01-01T12:00:00Z", "filerId": 0, "hostId": 0, "lastModificationDate": "2024-01-01T12:00:00Z", "maintenanceDateFrom": "2024-01-01T12:00:00Z", "maintenanceDateTo": "2024-01-01T12:00:00Z", "name": "string", "network": "string", "networkAccessId": 0, "orderId": 0, "parentTaskId": 0, "progress": 0, "state": "canceled", "taskId": 0, "type": "string", "userId": 0, "vlanId": 0}