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

Device

All operations require authentication.

5 operationsv1/overTheBox/devices · /overTheBox/{serviceName}
OpenAPI
Agent setup

List the devices available for registrationProduction

POST
/1.0/overTheBox/devices

List the devices available for registration. Returns the devices seen from the IP address of the call, with their ID, last seen date and whether each one is already activated.

Response

200DeviceForRegistration[]successful operation
activated
boolean

Whether or not this device is actived

deviceId
string
—
lastSeen
stringdate-time

The last time this device was seen on the provisionning servers

Reads your token from $OVH_TOKEN

$ curl https://api.eu.ovhcloud.com/1.0/overTheBox/devices \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  {    "activated": true,    "deviceId": "string",    "lastSeen": "2024-01-01T12:00:00Z"  }]

Get the device of an OverTheBox serviceProduction

GET
/1.0/overTheBox/{serviceName}/device

Get the device of an OverTheBox service. Returns the device ID, version, system information, public IP, network interfaces, last seen date and whether an update is available.

Path parameters

serviceName
required
string

The internal name of your overTheBox offer

Response

200Devicesuccessful operation
activated
read-only
boolean

Whether or not this device is associated to a service

availableUpdate
read-only
boolean

Whether or not an upate is available for this device

deviceId
read-only
string

The id of the device

lastSeen
read-only
stringdate-time

Last time the device has been seen on the provisionning servers

networkInterfaces
read-only
DeviceInterface[]

Network interfaces of the device

publicIp
read-only
ip

The public IP of the device

system
read-only
DeviceSystem

Device system information

systemVersion
read-only
string

System version of the device

version
read-only
string

Version of the device

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/overTheBox/{serviceName}/device \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "activated": true,  "availableUpdate": true,  "deviceId": "string",  "lastSeen": "2024-01-01T12:00:00Z",  "networkInterfaces": [    {      "device": "string",      "dnsServers": [        "192.0.2.0"      ],      "gateway": "192.0.2.0",      "ip": "192.0.2.0",      "multipathStatus": "backup",      "name": "string",      "netmask": "192.0.2.0",      "publicIp": "192.0.2.0"    }  ],  "publicIp": "192.0.2.0",  "system": {    "cpu": "string",    "hostname": "string",    "kernel": "string",    "mac": "string",    "model": "string",    "name": "string",    "offerName": "string",    "ovhName": "string"  },  "systemVersion": "string",  "version": "string"}

Unlink the device of an OverTheBox serviceProduction

DELETE
/1.0/overTheBox/{serviceName}/device

Unlink the device of an OverTheBox service. Removes the association between the device and the service. Link another device with linkDevice.

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}/device \
  -H "authorization: Bearer $OVH_TOKEN"

Get an OverTheBox hardwareProduction

GET
/1.0/overTheBox/{serviceName}/device/hardware

Get an OverTheBox hardware. Returns the name, model, serial and MAC address of a hardware, and whether it can be linked to a service without a device ID.

Path parameters

serviceName
required
string

The internal name of your overTheBox offer

Response

200Hardwaresuccessful operation
canBeLinkedToService
read-only
boolean

True if hardware can be linked to a service without deviceID

mac
read-only
macAddress

Hardware MAC address

model
read-only
string

Hardware model

name
read-only
string

Hardware name

prettyModelName
read-only
string

The hardware pretty model name

serial
read-only
string

Hardware serial

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/overTheBox/{serviceName}/device/hardware \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "canBeLinkedToService": true,  "mac": "00:00:5e:00:53:01",  "model": "string",  "name": "string",  "prettyModelName": "string",  "serial": "string"}

Generate a temporary URL for the device logsProduction

POST
/1.0/overTheBox/{serviceName}/device/logs

Generate a temporary URL for the device logs. Returns a temporary URL to download the logs of the OverTheBox device, with its expiration date.

Path parameters

serviceName
required
string

The internal name of your overTheBox offer

Response

200TemporaryLogsLinksuccessful operation
expirationDate
stringdate-time

Temporary url expiration date

url
string

Temporary url

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/overTheBox/{serviceName}/device/logs \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "expirationDate": "2024-01-01T12:00:00Z",  "url": "string"}