Skip to content

Features

All operations require authentication.

25 operationsv1/dedicated/server
Agent setup

Get the IPMI interfaceProduction

GET
/1.0/dedicated/server/{serviceName}/features/ipmi

Get the IPMI interface. Returns whether IPMI is available on the server and which access methods it supports. KVM is reached through an HTML or Java web interface, and the virtual serial port through an HTML interface or an SSH client.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200Ipmisuccessful operation
activated
read-only
boolean

true, if IPMI is available on this server

supportedFeatures
read-only
IpmiSupportedFeatures

A structure describing the IPMI supported features

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/ipmi \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "activated": true, "supportedFeatures": { "kvmipHtml5URL": true, "kvmipJnlp": true, "serialOverLanSshKey": true, "serialOverLanURL": true }}

Get the IPMI session accessProduction

GET
/1.0/dedicated/server/{serviceName}/features/ipmi/access

Get the IPMI session access. Returns the access value and the session expiration date for the given access type. Request the access with POST on the same route first: before that, and after expiration, the call returns an error.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Query parameters

type
required
IpmiAccessTypeEnum

IPMI console access

ValueskvmipHtml5URLkvmipJnlpserialOverLanSshKeyserialOverLanURL

Response

200IpmiAccessValuesuccessful operation
expiration
stringdate-time

Session expiration date

value
string

value

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/ipmi/access \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "expiration": "2024-01-01T12:00:00Z", "value": "string"}

Request IPMI accessProduction

POST
/1.0/dedicated/server/{serviceName}/features/ipmi/access

Request IPMI access. Requests an IPMI session for the given access type and returns a task. Once the task is done, read the access value and its expiration date with GET on the same route. sshKey, for serial over LAN SSH access, must be a raw public SSH key.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Request body (required)

ipToAllow
ipv4

IP to allow connection from for this IPMI session

sshKey
string

Public SSH key for Serial Over Lan SSH access | ⚠️ Starting 2024-08-27, SSH key name will no longer be accepted and only raw public SSH key will remain accepted

ttl
required
CacheTTLEnum

Session access time to live in minutes

Values1351015
type
required
IpmiAccessTypeEnum

IPMI console access

ValueskvmipHtml5URLkvmipJnlpserialOverLanSshKeyserialOverLanURL

Response

200Tasksuccessful operation
changeUuid
read-only
string

UUID of the change linked to this task

comment
read-only
string

Details of this task

doneDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesINFRA_002_VirtualNetworkInterfaceINFRA_002_VirtualNetworkInterface_groupINFRA_002_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_VirtualNetworkInterface_ungroupaddVirtualMacaddWindowSplaFromExistingSerialapplyBackupFtpAclsapplyBackupFtpQuotabypassAntiDDosGamechangePasswordBackupFTPchangeRipeOrgcheckAndReleaseIpcreateBackupFTPcreateOrUpdateRipeOrgcreatePrivateNetworkdisableFirewallenableFirewallgenericMoveFloatingIphardReboothardware_updateipmi/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDelete
lastUpdate
read-only
stringdate-time

last update

needSchedule
read-only
boolean

Whether this task need to be scheduled or not

note
read-only
string

Extra information about this task

plannedInterventionId
read-only
integer

ID of the planned intervention for this task

startDate
read-only
stringdate-time

Task Creation date

status
read-only
TaskStatusEnum

Task status

ValuescancelledcustomerErrordoingdoneinitovhErrortodo
tags
read-only
SafeKeyValueCanBeNull_string[]

Task result tags output

taskId
read-only
integer

the id of the task

ticketReference
read-only
string

Reference of the thread on the support tool

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/ipmi/access \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "changeUuid": "string", "comment": "string", "doneDate": "2024-01-01T12:00:00Z", "function": "INFRA_002_VirtualNetworkInterface", "lastUpdate": "2024-01-01T12:00:00Z", "needSchedule": true, "note": "string", "plannedInterventionId": 0, "startDate": "2024-01-01T12:00:00Z", "status": "cancelled", "tags": [ { "key": "string", "value": "string" } ], "taskId": 0, "ticketReference": "string"}

Reset the IPMI interfaceProduction

POST
/1.0/dedicated/server/{serviceName}/features/ipmi/resetInterface

Reset the IPMI interface. Resets the IPMI interface of the server and returns a task. The task carries the status and the completion date of the reset.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200Tasksuccessful operation
changeUuid
read-only
string

UUID of the change linked to this task

comment
read-only
string

Details of this task

doneDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesINFRA_002_VirtualNetworkInterfaceINFRA_002_VirtualNetworkInterface_groupINFRA_002_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_VirtualNetworkInterface_ungroupaddVirtualMacaddWindowSplaFromExistingSerialapplyBackupFtpAclsapplyBackupFtpQuotabypassAntiDDosGamechangePasswordBackupFTPchangeRipeOrgcheckAndReleaseIpcreateBackupFTPcreateOrUpdateRipeOrgcreatePrivateNetworkdisableFirewallenableFirewallgenericMoveFloatingIphardReboothardware_updateipmi/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDelete
lastUpdate
read-only
stringdate-time

last update

needSchedule
read-only
boolean

Whether this task need to be scheduled or not

note
read-only
string

Extra information about this task

plannedInterventionId
read-only
integer

ID of the planned intervention for this task

startDate
read-only
stringdate-time

Task Creation date

status
read-only
TaskStatusEnum

Task status

ValuescancelledcustomerErrordoingdoneinitovhErrortodo
tags
read-only
SafeKeyValueCanBeNull_string[]

Task result tags output

taskId
read-only
integer

the id of the task

ticketReference
read-only
string

Reference of the thread on the support tool

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/ipmi/resetInterface \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "changeUuid": "string", "comment": "string", "doneDate": "2024-01-01T12:00:00Z", "function": "INFRA_002_VirtualNetworkInterface", "lastUpdate": "2024-01-01T12:00:00Z", "needSchedule": true, "note": "string", "plannedInterventionId": 0, "startDate": "2024-01-01T12:00:00Z", "status": "cancelled", "tags": [ { "key": "string", "value": "string" } ], "taskId": 0, "ticketReference": "string"}

Reset IPMI sessionsProduction

POST
/1.0/dedicated/server/{serviceName}/features/ipmi/resetSessions

Reset IPMI sessions. Resets the IPMI sessions of the server and returns a task. Access values obtained before the reset stop working and must be requested again.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200Tasksuccessful operation
changeUuid
read-only
string

UUID of the change linked to this task

comment
read-only
string

Details of this task

doneDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesINFRA_002_VirtualNetworkInterfaceINFRA_002_VirtualNetworkInterface_groupINFRA_002_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_VirtualNetworkInterface_ungroupaddVirtualMacaddWindowSplaFromExistingSerialapplyBackupFtpAclsapplyBackupFtpQuotabypassAntiDDosGamechangePasswordBackupFTPchangeRipeOrgcheckAndReleaseIpcreateBackupFTPcreateOrUpdateRipeOrgcreatePrivateNetworkdisableFirewallenableFirewallgenericMoveFloatingIphardReboothardware_updateipmi/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDelete
lastUpdate
read-only
stringdate-time

last update

needSchedule
read-only
boolean

Whether this task need to be scheduled or not

note
read-only
string

Extra information about this task

plannedInterventionId
read-only
integer

ID of the planned intervention for this task

startDate
read-only
stringdate-time

Task Creation date

status
read-only
TaskStatusEnum

Task status

ValuescancelledcustomerErrordoingdoneinitovhErrortodo
tags
read-only
SafeKeyValueCanBeNull_string[]

Task result tags output

taskId
read-only
integer

the id of the task

ticketReference
read-only
string

Reference of the thread on the support tool

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/ipmi/resetSessions \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "changeUuid": "string", "comment": "string", "doneDate": "2024-01-01T12:00:00Z", "function": "INFRA_002_VirtualNetworkInterface", "lastUpdate": "2024-01-01T12:00:00Z", "needSchedule": true, "note": "string", "plannedInterventionId": 0, "startDate": "2024-01-01T12:00:00Z", "status": "cancelled", "tags": [ { "key": "string", "value": "string" } ], "taskId": 0, "ticketReference": "string"}

Get an IPMI test resultProduction

GET
/1.0/dedicated/server/{serviceName}/features/ipmi/test

Get an IPMI test result. Returns the result and the run date of the IPMI test of the given type: http, password or ping. Launch the test with POST on the same route first; the result is kept only for the ttl given at launch.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Query parameters

type
required
IpmiTestTypeEnum

Test type result on KVM IPMI interface

Valueshttppasswordping

Response

200IpmiTestResultsuccessful operation
date
stringdate-time

Test running date

status
string

Test result

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/ipmi/test \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "date": "2024-01-01T12:00:00Z", "status": "string"}

Test the IPMI interfaceProduction

POST
/1.0/dedicated/server/{serviceName}/features/ipmi/test

Test the IPMI interface. Launches an http, password or ping test on the IPMI interface and returns a task. ttl sets how long the result is kept: 1, 3, 5, 10 or 15 minutes. The result is read with GET on the same route.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Request body (required)

ttl
required
CacheTTLEnum

Result time to live in minutes

Values1351015
type
required
IpmiTestTypeEnum

Test to make on KVM IPMI interface

Valueshttppasswordping

Response

200Tasksuccessful operation
changeUuid
read-only
string

UUID of the change linked to this task

comment
read-only
string

Details of this task

doneDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesINFRA_002_VirtualNetworkInterfaceINFRA_002_VirtualNetworkInterface_groupINFRA_002_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_VirtualNetworkInterface_ungroupaddVirtualMacaddWindowSplaFromExistingSerialapplyBackupFtpAclsapplyBackupFtpQuotabypassAntiDDosGamechangePasswordBackupFTPchangeRipeOrgcheckAndReleaseIpcreateBackupFTPcreateOrUpdateRipeOrgcreatePrivateNetworkdisableFirewallenableFirewallgenericMoveFloatingIphardReboothardware_updateipmi/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDelete
lastUpdate
read-only
stringdate-time

last update

needSchedule
read-only
boolean

Whether this task need to be scheduled or not

note
read-only
string

Extra information about this task

plannedInterventionId
read-only
integer

ID of the planned intervention for this task

startDate
read-only
stringdate-time

Task Creation date

status
read-only
TaskStatusEnum

Task status

ValuescancelledcustomerErrordoingdoneinitovhErrortodo
tags
read-only
SafeKeyValueCanBeNull_string[]

Task result tags output

taskId
read-only
integer

the id of the task

ticketReference
read-only
string

Reference of the thread on the support tool

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/ipmi/test \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "changeUuid": "string", "comment": "string", "doneDate": "2024-01-01T12:00:00Z", "function": "INFRA_002_VirtualNetworkInterface", "lastUpdate": "2024-01-01T12:00:00Z", "needSchedule": true, "note": "string", "plannedInterventionId": 0, "startDate": "2024-01-01T12:00:00Z", "status": "cancelled", "tags": [ { "key": "string", "value": "string" } ], "taskId": 0, "ticketReference": "string"}

Get the physical KVMProduction

GET
/1.0/dedicated/server/{serviceName}/features/kvm

Get the physical KVM. Returns the physical KVM of the server: its hostname, access IP and expiration date. When no physical KVM is installed on the server, the call returns an error.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200kvmsuccessful operation
expiration
read-only
stringdate-time

KVM expiration date

ip
read-only
ipv4

KVM access ip

name
read-only
string

KVM hostname

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/kvm \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "expiration": "2024-01-01T12:00:00Z", "ip": "192.0.2.0", "name": "string"}

Get the firewallProduction

GET
/1.0/dedicated/server/{serviceName}/features/firewall

Get the firewall. Returns the firewall attached to the server: its management IP, model, mode and whether it is enabled. In transparent mode the firewall is invisible on the network; in routed mode it is a router hop.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200Firewallsuccessful operation
enabled
boolean
—
firewall
read-only
string
—
ip
read-only
ipv4

Firewall management IP

mode
read-only
FirewallModeEnum

transparent mode : device is invisible on the network; routed mode : the security appliance is considered to be a router hop in the network

Valuesroutedtransparent
model
read-only
FirewallModelEnum

Firewall model

Valuesasa5505asa5510asa5520

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/firewall \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "enabled": true, "firewall": "string", "ip": "192.0.2.0", "mode": "routed", "model": "asa5505"}

Update the firewallProduction

PUT
/1.0/dedicated/server/{serviceName}/features/firewall

Update the firewall. Updates the firewall attached to the server. Only the enabled field can be changed; the other fields are read-only.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Request body (required)

enabled
boolean
—
firewall
read-only
string
—
ip
read-only
ipv4

Firewall management IP

mode
read-only
FirewallModeEnum

transparent mode : device is invisible on the network; routed mode : the security appliance is considered to be a router hop in the network

Valuesroutedtransparent
model
read-only
FirewallModelEnum

Firewall model

Valuesasa5505asa5510asa5520

Response

200—successful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/firewall \
  -H "authorization: Bearer $OVH_TOKEN"

Get the cloud backupBeta

GET
/1.0/dedicated/server/{serviceName}/features/backupCloud

Get the cloud backup. Returns the cloud backup of the server: its storage and archive containers, its status and the agreements waiting for validation.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200BackupCloudsuccessful operation
agreements
read-only
integer[]

Agreement ids waiting for validation

archive
read-only
BackupContainer

Archive space info.

status
read-only
BackupStatus

Status of the container.

storage
read-only
BackupContainer

Storage space info.

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/backupCloud \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "agreements": [ 0 ], "archive": { "cloudProject": { "description": "string", "projectId": "string" }, "id": "string", "name": "string", "quota": { "maxBandwidth": { "unit": "string", "value": 0 }, "maxStorage": { "unit": "string", "value": 0 }, "storageUsed": { "unit": "string", "value": 0 }, "usagePercent": 0 }, "region": "string", "sftp": { "password": "string", "url": "string", "username": "string" }, "swift": { "authUrl": "string", "password": "string", "username": "string" } }, "status": { "code": "DELETING", "reason": "string" }, "storage": { "cloudProject": { "description": "string", "projectId": "string" }, "id": "string", "name": "string", "quota": { "maxBandwidth": { "unit": "string", "value": 0 }, "maxStorage": { "unit": "string", "value": 0 }, "storageUsed": { "unit": "string", "value": 0 }, "usagePercent": 0 }, "region": "string", "sftp": { "password": "string", "url": "string", "username": "string" }, "swift": { "authUrl": "string", "password": "string", "username": "string" } }}

Create the cloud backupBeta

POST
/1.0/dedicated/server/{serviceName}/features/backupCloud

Create the cloud backup. Creates the cloud backup of the server, with storage and archive containers in a cloud project. Set cloudProjectId to use an existing project; otherwise a project is created, described by projectDescription.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Request body (required)

cloudProjectId
string

cloud project id

projectDescription
string

Project description of the project to be created (ignored when an existing project is already specified)

Response

200BackupCloudsuccessful operation
agreements
read-only
integer[]

Agreement ids waiting for validation

archive
read-only
BackupContainer

Archive space info.

status
read-only
BackupStatus

Status of the container.

storage
read-only
BackupContainer

Storage space info.

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/backupCloud \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "agreements": [ 0 ], "archive": { "cloudProject": { "description": "string", "projectId": "string" }, "id": "string", "name": "string", "quota": { "maxBandwidth": { "unit": "string", "value": 0 }, "maxStorage": { "unit": "string", "value": 0 }, "storageUsed": { "unit": "string", "value": 0 }, "usagePercent": 0 }, "region": "string", "sftp": { "password": "string", "url": "string", "username": "string" }, "swift": { "authUrl": "string", "password": "string", "username": "string" } }, "status": { "code": "DELETING", "reason": "string" }, "storage": { "cloudProject": { "description": "string", "projectId": "string" }, "id": "string", "name": "string", "quota": { "maxBandwidth": { "unit": "string", "value": 0 }, "maxStorage": { "unit": "string", "value": 0 }, "storageUsed": { "unit": "string", "value": 0 }, "usagePercent": 0 }, "region": "string", "sftp": { "password": "string", "url": "string", "username": "string" }, "swift": { "authUrl": "string", "password": "string", "username": "string" } }}

Deactivate the cloud backupBeta

DELETE
/1.0/dedicated/server/{serviceName}/features/backupCloud

Deactivate the cloud backup. Deactivates the cloud backup of the server. The container data is not deleted.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200—successful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/backupCloud \
  -H "authorization: Bearer $OVH_TOKEN"

Regenerate cloud backup passwordsBeta

POST
/1.0/dedicated/server/{serviceName}/features/backupCloud/password

Regenerate cloud backup passwords. Regenerates the cloud backup passwords and returns them: the Swift and SFTP passwords of the storage and archive containers.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200BackupPasswordsuccessful operation
sftpArchive
stringpassword

Password to reach the archive container through the sftp gw.

sftpStorage
stringpassword

Password to reach the storage container through the sftp gw.

swiftArchive
stringpassword

Password to reach the archive container through swift.

swiftStorage
stringpassword

Password to reach the storage container through swift.

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/backupCloud/password \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "sftpArchive": "string", "sftpStorage": "string", "swiftArchive": "string", "swiftStorage": "string"}

Get the backup FTP spaceProduction

GET
/1.0/dedicated/server/{serviceName}/features/backupFTP

Get the backup FTP space. Returns the backup FTP space: its server name, type, available disk space and usage. readOnlyDate is set when the account was switched to read-only because the quota was exceeded.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200BackupFtpsuccessful operation
ftpBackupName
read-only
string

The backup FTP server name

quota
read-only
UnitAndValue_long

The disk space available in gigabytes

readOnlyDate
read-only
stringdate-time

If not-null, gives the date since when your account was set in read-only mode because the quota was exceeded

type
read-only
BackupStorageTypeEnum

The backup FTP type

Valuesincludedstorage
usage
read-only
UnitAndValue_long

The disk space currently used on your backup FTP in percent

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/backupFTP \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "ftpBackupName": "string", "quota": { "unit": "string", "value": 0 }, "readOnlyDate": "2024-01-01T12:00:00Z", "type": "included", "usage": { "unit": "string", "value": 0 }}

Create the backup FTP spaceProduction

POST
/1.0/dedicated/server/{serviceName}/features/backupFTP

Create the backup FTP space. Creates the backup FTP space and returns a task. The IP blocks allowed to reach it, and their protocols, are managed with the access routes.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200Tasksuccessful operation
changeUuid
read-only
string

UUID of the change linked to this task

comment
read-only
string

Details of this task

doneDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesINFRA_002_VirtualNetworkInterfaceINFRA_002_VirtualNetworkInterface_groupINFRA_002_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_VirtualNetworkInterface_ungroupaddVirtualMacaddWindowSplaFromExistingSerialapplyBackupFtpAclsapplyBackupFtpQuotabypassAntiDDosGamechangePasswordBackupFTPchangeRipeOrgcheckAndReleaseIpcreateBackupFTPcreateOrUpdateRipeOrgcreatePrivateNetworkdisableFirewallenableFirewallgenericMoveFloatingIphardReboothardware_updateipmi/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDelete
lastUpdate
read-only
stringdate-time

last update

needSchedule
read-only
boolean

Whether this task need to be scheduled or not

note
read-only
string

Extra information about this task

plannedInterventionId
read-only
integer

ID of the planned intervention for this task

startDate
read-only
stringdate-time

Task Creation date

status
read-only
TaskStatusEnum

Task status

ValuescancelledcustomerErrordoingdoneinitovhErrortodo
tags
read-only
SafeKeyValueCanBeNull_string[]

Task result tags output

taskId
read-only
integer

the id of the task

ticketReference
read-only
string

Reference of the thread on the support tool

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/backupFTP \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "changeUuid": "string", "comment": "string", "doneDate": "2024-01-01T12:00:00Z", "function": "INFRA_002_VirtualNetworkInterface", "lastUpdate": "2024-01-01T12:00:00Z", "needSchedule": true, "note": "string", "plannedInterventionId": 0, "startDate": "2024-01-01T12:00:00Z", "status": "cancelled", "tags": [ { "key": "string", "value": "string" } ], "taskId": 0, "ticketReference": "string"}

Delete the backup FTP spaceProduction

DELETE
/1.0/dedicated/server/{serviceName}/features/backupFTP

Delete the backup FTP space. Terminates the backup FTP space and returns a task. All data stored on it is permanently deleted.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200Tasksuccessful operation
changeUuid
read-only
string

UUID of the change linked to this task

comment
read-only
string

Details of this task

doneDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesINFRA_002_VirtualNetworkInterfaceINFRA_002_VirtualNetworkInterface_groupINFRA_002_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_VirtualNetworkInterface_ungroupaddVirtualMacaddWindowSplaFromExistingSerialapplyBackupFtpAclsapplyBackupFtpQuotabypassAntiDDosGamechangePasswordBackupFTPchangeRipeOrgcheckAndReleaseIpcreateBackupFTPcreateOrUpdateRipeOrgcreatePrivateNetworkdisableFirewallenableFirewallgenericMoveFloatingIphardReboothardware_updateipmi/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDelete
lastUpdate
read-only
stringdate-time

last update

needSchedule
read-only
boolean

Whether this task need to be scheduled or not

note
read-only
string

Extra information about this task

plannedInterventionId
read-only
integer

ID of the planned intervention for this task

startDate
read-only
stringdate-time

Task Creation date

status
read-only
TaskStatusEnum

Task status

ValuescancelledcustomerErrordoingdoneinitovhErrortodo
tags
read-only
SafeKeyValueCanBeNull_string[]

Task result tags output

taskId
read-only
integer

the id of the task

ticketReference
read-only
string

Reference of the thread on the support tool

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/backupFTP \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "changeUuid": "string", "comment": "string", "doneDate": "2024-01-01T12:00:00Z", "function": "INFRA_002_VirtualNetworkInterface", "lastUpdate": "2024-01-01T12:00:00Z", "needSchedule": true, "note": "string", "plannedInterventionId": 0, "startDate": "2024-01-01T12:00:00Z", "status": "cancelled", "tags": [ { "key": "string", "value": "string" } ], "taskId": 0, "ticketReference": "string"}

List backup FTP ACLsProduction

GET
/1.0/dedicated/server/{serviceName}/features/backupFTP/access

List backup FTP ACLs. Returns the IP blocks authorized on the backup FTP space. Get an ACL to see the protocols it allows: FTP, NFS and CIFS (SMB).

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200ipBlock[]successful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/backupFTP/access \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ "192.0.2.0/24"]

Create a backup FTP ACLProduction

POST
/1.0/dedicated/server/{serviceName}/features/backupFTP/access

Create a backup FTP ACL. Authorizes an IP block on the backup FTP space with the chosen protocols and returns a task. At least one of ftp, nfs and cifs must be enabled; ftp is false when omitted. authorizableBlocks lists the eligible blocks.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Request body (required)

cifs
required
boolean

Whether to allow the CIFS (SMB) protocol for this ACL

ftp
boolean

Whether to allow the FTP protocol for this ACL

ipBlock
required
ipBlock

The IP Block specific to this ACL. It musts belong to your server.

nfs
required
boolean

Whether to allow the NFS protocol for this ACL

Response

200Tasksuccessful operation
changeUuid
read-only
string

UUID of the change linked to this task

comment
read-only
string

Details of this task

doneDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesINFRA_002_VirtualNetworkInterfaceINFRA_002_VirtualNetworkInterface_groupINFRA_002_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_VirtualNetworkInterface_ungroupaddVirtualMacaddWindowSplaFromExistingSerialapplyBackupFtpAclsapplyBackupFtpQuotabypassAntiDDosGamechangePasswordBackupFTPchangeRipeOrgcheckAndReleaseIpcreateBackupFTPcreateOrUpdateRipeOrgcreatePrivateNetworkdisableFirewallenableFirewallgenericMoveFloatingIphardReboothardware_updateipmi/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDelete
lastUpdate
read-only
stringdate-time

last update

needSchedule
read-only
boolean

Whether this task need to be scheduled or not

note
read-only
string

Extra information about this task

plannedInterventionId
read-only
integer

ID of the planned intervention for this task

startDate
read-only
stringdate-time

Task Creation date

status
read-only
TaskStatusEnum

Task status

ValuescancelledcustomerErrordoingdoneinitovhErrortodo
tags
read-only
SafeKeyValueCanBeNull_string[]

Task result tags output

taskId
read-only
integer

the id of the task

ticketReference
read-only
string

Reference of the thread on the support tool

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/backupFTP/access \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "changeUuid": "string", "comment": "string", "doneDate": "2024-01-01T12:00:00Z", "function": "INFRA_002_VirtualNetworkInterface", "lastUpdate": "2024-01-01T12:00:00Z", "needSchedule": true, "note": "string", "plannedInterventionId": 0, "startDate": "2024-01-01T12:00:00Z", "status": "cancelled", "tags": [ { "key": "string", "value": "string" } ], "taskId": 0, "ticketReference": "string"}

Get a backup FTP ACLProduction

GET
/1.0/dedicated/server/{serviceName}/features/backupFTP/access/{ipBlock}

Get a backup FTP ACL. Returns the protocols allowed for the IP block (FTP, NFS, CIFS), whether the rule is applied on the backup FTP space and its last update date.

Path parameters

ipBlock
required
ipBlock

The IP Block specific to this ACL

serviceName
required
string

The internal name of your dedicated server

Response

200BackupFtpAclsuccessful operation
cifs
boolean

Whether to allow the CIFS (SMB) protocol for this ACL

ftp
boolean

Whether to allow the FTP protocol for this ACL

ipBlock
read-only
ipBlock

The IP Block specific to this ACL

isApplied
read-only
boolean

Whether the rule has been applied on the Backup Ftp

lastUpdate
read-only
stringdate-time

Date of the last object modification

nfs
boolean

Whether to allow the NFS protocol for this ACL

Example uses ipBlock = 192.0.2.0/24, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/backupFTP/access/{ipBlock} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "cifs": true, "ftp": true, "ipBlock": "192.0.2.0/24", "isApplied": true, "lastUpdate": "2024-01-01T12:00:00Z", "nfs": true}

Delete a backup FTP ACLProduction

DELETE
/1.0/dedicated/server/{serviceName}/features/backupFTP/access/{ipBlock}

Delete a backup FTP ACL. Revokes the access of the IP block to the backup FTP space and returns a task. The task carries the status of the revocation.

Path parameters

ipBlock
required
ipBlock

The IP Block specific to this ACL

serviceName
required
string

The internal name of your dedicated server

Response

200Tasksuccessful operation
changeUuid
read-only
string

UUID of the change linked to this task

comment
read-only
string

Details of this task

doneDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesINFRA_002_VirtualNetworkInterfaceINFRA_002_VirtualNetworkInterface_groupINFRA_002_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_VirtualNetworkInterface_ungroupaddVirtualMacaddWindowSplaFromExistingSerialapplyBackupFtpAclsapplyBackupFtpQuotabypassAntiDDosGamechangePasswordBackupFTPchangeRipeOrgcheckAndReleaseIpcreateBackupFTPcreateOrUpdateRipeOrgcreatePrivateNetworkdisableFirewallenableFirewallgenericMoveFloatingIphardReboothardware_updateipmi/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDelete
lastUpdate
read-only
stringdate-time

last update

needSchedule
read-only
boolean

Whether this task need to be scheduled or not

note
read-only
string

Extra information about this task

plannedInterventionId
read-only
integer

ID of the planned intervention for this task

startDate
read-only
stringdate-time

Task Creation date

status
read-only
TaskStatusEnum

Task status

ValuescancelledcustomerErrordoingdoneinitovhErrortodo
tags
read-only
SafeKeyValueCanBeNull_string[]

Task result tags output

taskId
read-only
integer

the id of the task

ticketReference
read-only
string

Reference of the thread on the support tool

Example uses ipBlock = 192.0.2.0/24, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/backupFTP/access/{ipBlock} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "changeUuid": "string", "comment": "string", "doneDate": "2024-01-01T12:00:00Z", "function": "INFRA_002_VirtualNetworkInterface", "lastUpdate": "2024-01-01T12:00:00Z", "needSchedule": true, "note": "string", "plannedInterventionId": 0, "startDate": "2024-01-01T12:00:00Z", "status": "cancelled", "tags": [ { "key": "string", "value": "string" } ], "taskId": 0, "ticketReference": "string"}

Update a backup FTP ACLProduction

PUT
/1.0/dedicated/server/{serviceName}/features/backupFTP/access/{ipBlock}

Update a backup FTP ACL. Updates the protocols allowed for the IP block: ftp, nfs and cifs. The change is applied asynchronously: isApplied stays false until it is in effect.

Path parameters

ipBlock
required
ipBlock

The IP Block specific to this ACL

serviceName
required
string

The internal name of your dedicated server

Request body (required)

cifs
boolean

Whether to allow the CIFS (SMB) protocol for this ACL

ftp
boolean

Whether to allow the FTP protocol for this ACL

ipBlock
read-only
ipBlock

The IP Block specific to this ACL

isApplied
read-only
boolean

Whether the rule has been applied on the Backup Ftp

lastUpdate
read-only
stringdate-time

Date of the last object modification

nfs
boolean

Whether to allow the NFS protocol for this ACL

Response

200—successful operation

Example uses ipBlock = 192.0.2.0/24, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/backupFTP/access/{ipBlock} \
  -H "authorization: Bearer $OVH_TOKEN"

List authorizable IP blocksProduction

GET
/1.0/dedicated/server/{serviceName}/features/backupFTP/authorizableBlocks

List authorizable IP blocks. Returns the IP blocks of the account that can be authorized in a backup FTP ACL. They include blocks routed to other services of the account, not only to this server.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200ipBlock[]successful operation

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/backupFTP/authorizableBlocks \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ "192.0.2.0/24"]

Reset the backup FTP passwordProduction

POST
/1.0/dedicated/server/{serviceName}/features/backupFTP/password

Reset the backup FTP password. Resets the backup FTP password and returns a task. The response does not contain the new password.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200Tasksuccessful operation
changeUuid
read-only
string

UUID of the change linked to this task

comment
read-only
string

Details of this task

doneDate
read-only
stringdate-time

Completion date

function
read-only
TaskFunctionEnum

Function name

ValuesINFRA_002_VirtualNetworkInterfaceINFRA_002_VirtualNetworkInterface_groupINFRA_002_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_ONEAPI_VirtualNetworkInterface_ungroupINFRA_ONE_NETWORK_VirtualNetworkInterface_groupINFRA_ONE_NETWORK_VirtualNetworkInterface_ungroupaddVirtualMacaddWindowSplaFromExistingSerialapplyBackupFtpAclsapplyBackupFtpQuotabypassAntiDDosGamechangePasswordBackupFTPchangeRipeOrgcheckAndReleaseIpcreateBackupFTPcreateOrUpdateRipeOrgcreatePrivateNetworkdisableFirewallenableFirewallgenericMoveFloatingIphardReboothardware_updateipmi/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDelete
lastUpdate
read-only
stringdate-time

last update

needSchedule
read-only
boolean

Whether this task need to be scheduled or not

note
read-only
string

Extra information about this task

plannedInterventionId
read-only
integer

ID of the planned intervention for this task

startDate
read-only
stringdate-time

Task Creation date

status
read-only
TaskStatusEnum

Task status

ValuescancelledcustomerErrordoingdoneinitovhErrortodo
tags
read-only
SafeKeyValueCanBeNull_string[]

Task result tags output

taskId
read-only
integer

the id of the task

ticketReference
read-only
string

Reference of the thread on the support tool

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/features/backupFTP/password \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "changeUuid": "string", "comment": "string", "doneDate": "2024-01-01T12:00:00Z", "function": "INFRA_002_VirtualNetworkInterface", "lastUpdate": "2024-01-01T12:00:00Z", "needSchedule": true, "note": "string", "plannedInterventionId": 0, "startDate": "2024-01-01T12:00:00Z", "status": "cancelled", "tags": [ { "key": "string", "value": "string" } ], "taskId": 0, "ticketReference": "string"}

Get the cloud backup offerBeta

GET
/1.0/dedicated/server/{serviceName}/backupCloudOfferDetails

Get the cloud backup offer. Returns the cloud backup offer available for the server: the maximum size and the monthly read/write volume of the storage and archive containers. When no offer is available, the call returns an error.

Path parameters

serviceName
required
string

The internal name of your dedicated server

Response

200BackupOffersuccessful operation
maxArchive
UnitAndValue_long

Archive container max size.

maxBandwidthArchive
UnitAndValue_long

Archive volume r/w bandwidth limit: read/write volume offered per month on the container.

maxBandwidthStorage
UnitAndValue_long

Storage volume r/w bandwidth limit: read/write volume offered per month on the container.

maxStorage
UnitAndValue_long

Storage container max size.

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicated/server/{serviceName}/backupCloudOfferDetails \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "maxArchive": { "unit": "string", "value": 0 }, "maxBandwidthArchive": { "unit": "string", "value": 0 }, "maxBandwidthStorage": { "unit": "string", "value": 0 }, "maxStorage": { "unit": "string", "value": 0 }}