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

Dedicated servers

All operations require authentication.

10 operationsv1/vrack/{serviceName}
OpenAPI
Agent setup

List server interfaces. Returns the dedicated server network interfaces attached to the vRack.Production

GET
/1.0/vrack/{serviceName}/dedicatedServerInterface

Path parameters

serviceName
required
string

The internal name of your vrack

Response

200string[]successful operation

Example uses serviceName = string

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

Get a server interface. Returns the attached interface and its vRack.Production

GET
/1.0/vrack/{serviceName}/dedicatedServerInterface/{dedicatedServerInterface}

Path parameters

dedicatedServerInterface
required
string

Dedicated Server Interface

serviceName
required
string

The internal name of your vrack

Response

200dedicatedServerInterfacesuccessful operation
dedicatedServerInterface
read-only
string

Dedicated Server Interface

vrack
read-only
string

vrack name

Example uses dedicatedServerInterface = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/vrack/{serviceName}/dedicatedServerInterface/{dedicatedServerInterface} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "dedicatedServerInterface": "string",  "vrack": "string"}

Attach a server interfaceProduction

POST
/1.0/vrack/{serviceName}/dedicatedServerInterface

Attach a server interface. Attaches a dedicated server network interface to the vRack. Returns the task that performs it.

Path parameters

serviceName
required
string

The internal name of your vrack

Request body (required)

dedicatedServerInterface
required
string

Dedicated server interface to add

Response

200Tasksuccessful operation
function
read-only
string
—
id
read-only
integer
—
lastUpdate
read-only
stringdate-time
—
orderId
read-only
integer
—
serviceName
read-only
string
—
status
read-only
TaskStatusEnum

Task status

Valuescancelleddoingdoneinittodo
targetDomain
read-only
string
—
todoDate
read-only
stringdate-time
—

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/vrack/{serviceName}/dedicatedServerInterface \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "function": "string",  "id": 0,  "lastUpdate": "2024-01-01T12:00:00Z",  "orderId": 0,  "serviceName": "string",  "status": "cancelled",  "targetDomain": "string",  "todoDate": "2024-01-01T12:00:00Z"}

Detach a server interface. Detaches the interface from the vRack. Returns the task that performs it.Production

DELETE
/1.0/vrack/{serviceName}/dedicatedServerInterface/{dedicatedServerInterface}

Path parameters

dedicatedServerInterface
required
string

Dedicated Server Interface

serviceName
required
string

The internal name of your vrack

Response

200Tasksuccessful operation
function
read-only
string
—
id
read-only
integer
—
lastUpdate
read-only
stringdate-time
—
orderId
read-only
integer
—
serviceName
read-only
string
—
status
read-only
TaskStatusEnum

Task status

Valuescancelleddoingdoneinittodo
targetDomain
read-only
string
—
todoDate
read-only
stringdate-time
—

Example uses dedicatedServerInterface = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/vrack/{serviceName}/dedicatedServerInterface/{dedicatedServerInterface} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "function": "string",  "id": 0,  "lastUpdate": "2024-01-01T12:00:00Z",  "orderId": 0,  "serviceName": "string",  "status": "cancelled",  "targetDomain": "string",  "todoDate": "2024-01-01T12:00:00Z"}

List server interface details. Returns the attached interfaces with the server each one belongs to.Production

GET
/1.0/vrack/{serviceName}/dedicatedServerInterfaceDetails

Path parameters

serviceName
required
string

The internal name of your vrack

Response

200AllowedDedicatedServerInterfaces[]successful operation
dedicatedServer
string

the name of dedicatedServer

dedicatedServerInterface
string

the unique identifier of dedicatedServerInterface

name
string

the name of dedicatedServerInterface

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/vrack/{serviceName}/dedicatedServerInterfaceDetails \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  {    "dedicatedServer": "string",    "dedicatedServerInterface": "string",    "name": "string"  }]

List servers (legacy)Production

GET
/1.0/vrack/{serviceName}/dedicatedServer

List servers (legacy). Returns the dedicated servers attached as a whole to the vRack, in the legacy mode. Attaching by interface replaces it.

Path parameters

serviceName
required
string

The internal name of your vrack

Response

200string[]successful operation

Example uses serviceName = string

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

Get a server link (legacy)Production

GET
/1.0/vrack/{serviceName}/dedicatedServer/{dedicatedServer}

Get a server link (legacy). Returns the attached server and its vRack. This is the legacy whole-server link, not an interface link.

Path parameters

dedicatedServer
required
string

Dedicated Server

serviceName
required
string

The internal name of your vrack

Response

200dedicatedServersuccessful operation
dedicatedServer
read-only
string

Dedicated Server

vrack
read-only
string

vrack name

Example uses dedicatedServer = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/vrack/{serviceName}/dedicatedServer/{dedicatedServer} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "dedicatedServer": "string",  "vrack": "string"}

Attach a server (legacy)Production

POST
/1.0/vrack/{serviceName}/dedicatedServer

Attach a server (legacy). Attaches a whole dedicated server to the vRack, in the legacy mode. Prefer attaching one of its interfaces. Returns the task that performs it.

Path parameters

serviceName
required
string

The internal name of your vrack

Request body (required)

dedicatedServer
required
string

Dedicated server to add

Response

200Tasksuccessful operation
function
read-only
string
—
id
read-only
integer
—
lastUpdate
read-only
stringdate-time
—
orderId
read-only
integer
—
serviceName
read-only
string
—
status
read-only
TaskStatusEnum

Task status

Valuescancelleddoingdoneinittodo
targetDomain
read-only
string
—
todoDate
read-only
stringdate-time
—

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/vrack/{serviceName}/dedicatedServer \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "function": "string",  "id": 0,  "lastUpdate": "2024-01-01T12:00:00Z",  "orderId": 0,  "serviceName": "string",  "status": "cancelled",  "targetDomain": "string",  "todoDate": "2024-01-01T12:00:00Z"}

Detach a server (legacy)Production

DELETE
/1.0/vrack/{serviceName}/dedicatedServer/{dedicatedServer}

Detach a server (legacy). Detaches a whole dedicated server from the vRack, in the legacy mode. Returns the task that performs it.

Path parameters

dedicatedServer
required
string

Dedicated Server

serviceName
required
string

The internal name of your vrack

Response

200Tasksuccessful operation
function
read-only
string
—
id
read-only
integer
—
lastUpdate
read-only
stringdate-time
—
orderId
read-only
integer
—
serviceName
read-only
string
—
status
read-only
TaskStatusEnum

Task status

Valuescancelleddoingdoneinittodo
targetDomain
read-only
string
—
todoDate
read-only
stringdate-time
—

Example uses dedicatedServer = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/vrack/{serviceName}/dedicatedServer/{dedicatedServer} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "function": "string",  "id": 0,  "lastUpdate": "2024-01-01T12:00:00Z",  "orderId": 0,  "serviceName": "string",  "status": "cancelled",  "targetDomain": "string",  "todoDate": "2024-01-01T12:00:00Z"}

Get traffic graph values (deprecated)Deprecated

GET
/1.0/vrack/{serviceName}/dedicatedServer/{dedicatedServer}/mrtg

Deprecated since Oct 22, 2017, will be removed on Apr 22, 2018 — use /dedicated/server/{serviceName}/networkInterfaceController instead.

Get traffic graph values (deprecated). Returns the traffic, packets or errors measured on the vRack port of the server, for a period from hourly to yearly. Deprecated: use the dedicated server statistics instead.

Path parameters

dedicatedServer
required
string

Dedicated Server

serviceName
required
string

The internal name of your vrack

Query parameters

period
required
MrtgPeriodEnum

mrtg period

Valuesdailyhourlymonthlyweeklyyearly
type
required
MrtgTypeEnum

mrtg type

Valueserrors:downloaderrors:uploadpackets:downloadpackets:uploadtraffic:downloadtraffic:upload

Response

200MrtgTimestampValue[]successful operation
timestamp
integer
—
value
UnitAndValue_double

A numeric value tagged with its unit

Example uses dedicatedServer = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/vrack/{serviceName}/dedicatedServer/{dedicatedServer}/mrtg \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  {    "timestamp": 0,    "value": {      "unit": "string",      "value": 0    }  }]