Features
All operations require authentication.
Get the IPMI interfaceProduction
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
The internal name of your dedicated server
Response
true, if IPMI is available on this server
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"{ "activated": true, "supportedFeatures": { "kvmipHtml5URL": true, "kvmipJnlp": true, "serialOverLanSshKey": true, "serialOverLanURL": true }}
Get the IPMI session accessProduction
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
The internal name of your dedicated server
Query parameters
IPMI console access
kvmipHtml5URLkvmipJnlpserialOverLanSshKeyserialOverLanURLResponse
Session expiration date
value
Example uses serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ dedicated/ server/ {serviceName}/ features/ ipmi/ access \
-H "authorization: Bearer $OVH_TOKEN"{ "expiration": "2024-01-01T12:00:00Z", "value": "string"}
Request IPMI accessProduction
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
The internal name of your dedicated server
Request body (required)
IP to allow connection from for this IPMI session
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
Session access time to live in minutes
1351015IPMI console access
kvmipHtml5URLkvmipJnlpserialOverLanSshKeyserialOverLanURLResponse
UUID of the change linked to this task
Details of this task
Completion date
Function name
INFRA_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/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDeletelast update
Whether this task need to be scheduled or not
Extra information about this task
ID of the planned intervention for this task
Task Creation date
Task status
cancelledcustomerErrordoingdoneinitovhErrortodoTask result tags output
the id of the task
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"{ "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
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
The internal name of your dedicated server
Response
UUID of the change linked to this task
Details of this task
Completion date
Function name
INFRA_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/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDeletelast update
Whether this task need to be scheduled or not
Extra information about this task
ID of the planned intervention for this task
Task Creation date
Task status
cancelledcustomerErrordoingdoneinitovhErrortodoTask result tags output
the id of the task
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"{ "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
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
The internal name of your dedicated server
Response
UUID of the change linked to this task
Details of this task
Completion date
Function name
INFRA_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/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDeletelast update
Whether this task need to be scheduled or not
Extra information about this task
ID of the planned intervention for this task
Task Creation date
Task status
cancelledcustomerErrordoingdoneinitovhErrortodoTask result tags output
the id of the task
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"{ "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 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
The internal name of your dedicated server
Query parameters
Test type result on KVM IPMI interface
httppasswordpingResponse
Test running date
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"{ "date": "2024-01-01T12:00:00Z", "status": "string"}
Test the IPMI interfaceProduction
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
The internal name of your dedicated server
Request body (required)
Result time to live in minutes
1351015Test to make on KVM IPMI interface
httppasswordpingResponse
UUID of the change linked to this task
Details of this task
Completion date
Function name
INFRA_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/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDeletelast update
Whether this task need to be scheduled or not
Extra information about this task
ID of the planned intervention for this task
Task Creation date
Task status
cancelledcustomerErrordoingdoneinitovhErrortodoTask result tags output
the id of the task
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"{ "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 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
The internal name of your dedicated server
Response
KVM expiration date
KVM access ip
KVM hostname
Example uses serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ dedicated/ server/ {serviceName}/ features/ kvm \
-H "authorization: Bearer $OVH_TOKEN"{ "expiration": "2024-01-01T12:00:00Z", "ip": "192.0.2.0", "name": "string"}
Get the firewallProduction
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
The internal name of your dedicated server
Response
Firewall management IP
transparent mode : device is invisible on the network; routed mode : the security appliance is considered to be a router hop in the network
routedtransparentFirewall model
asa5505asa5510asa5520Example uses serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ dedicated/ server/ {serviceName}/ features/ firewall \
-H "authorization: Bearer $OVH_TOKEN"{ "enabled": true, "firewall": "string", "ip": "192.0.2.0", "mode": "routed", "model": "asa5505"}
Update the firewallProduction
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
The internal name of your dedicated server
Request body (required)
Firewall management IP
transparent mode : device is invisible on the network; routed mode : the security appliance is considered to be a router hop in the network
routedtransparentFirewall model
asa5505asa5510asa5520Response
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 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
The internal name of your dedicated server
Response
Agreement ids waiting for validation
Archive space info.
Status of the container.
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"{ "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
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
The internal name of your dedicated server
Request body (required)
cloud project id
Project description of the project to be created (ignored when an existing project is already specified)
Response
Agreement ids waiting for validation
Archive space info.
Status of the container.
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"{ "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
Deactivate the cloud backup. Deactivates the cloud backup of the server. The container data is not deleted.
Path parameters
The internal name of your dedicated server
Response
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
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
The internal name of your dedicated server
Response
Password to reach the archive container through the sftp gw.
Password to reach the storage container through the sftp gw.
Password to reach the archive container through swift.
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"{ "sftpArchive": "string", "sftpStorage": "string", "swiftArchive": "string", "swiftStorage": "string"}
Get the backup FTP spaceProduction
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
The internal name of your dedicated server
Response
The backup FTP server name
The disk space available in gigabytes
If not-null, gives the date since when your account was set in read-only mode because the quota was exceeded
The backup FTP type
includedstorageThe 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"{ "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
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
The internal name of your dedicated server
Response
UUID of the change linked to this task
Details of this task
Completion date
Function name
INFRA_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/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDeletelast update
Whether this task need to be scheduled or not
Extra information about this task
ID of the planned intervention for this task
Task Creation date
Task status
cancelledcustomerErrordoingdoneinitovhErrortodoTask result tags output
the id of the task
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"{ "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 the backup FTP space. Terminates the backup FTP space and returns a task. All data stored on it is permanently deleted.
Path parameters
The internal name of your dedicated server
Response
UUID of the change linked to this task
Details of this task
Completion date
Function name
INFRA_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/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDeletelast update
Whether this task need to be scheduled or not
Extra information about this task
ID of the planned intervention for this task
Task Creation date
Task status
cancelledcustomerErrordoingdoneinitovhErrortodoTask result tags output
the id of the task
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"{ "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
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
The internal name of your dedicated server
Response
Example uses serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ 1.0/ dedicated/ server/ {serviceName}/ features/ backupFTP/ access \
-H "authorization: Bearer $OVH_TOKEN"[ "192.0.2.0/24"]
Create a backup FTP ACLProduction
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
The internal name of your dedicated server
Request body (required)
Whether to allow the CIFS (SMB) protocol for this ACL
Whether to allow the FTP protocol for this ACL
The IP Block specific to this ACL. It musts belong to your server.
Whether to allow the NFS protocol for this ACL
Response
UUID of the change linked to this task
Details of this task
Completion date
Function name
INFRA_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/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDeletelast update
Whether this task need to be scheduled or not
Extra information about this task
ID of the planned intervention for this task
Task Creation date
Task status
cancelledcustomerErrordoingdoneinitovhErrortodoTask result tags output
the id of the task
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"{ "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 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
The IP Block specific to this ACL
The internal name of your dedicated server
Response
Whether to allow the CIFS (SMB) protocol for this ACL
Whether to allow the FTP protocol for this ACL
The IP Block specific to this ACL
Whether the rule has been applied on the Backup Ftp
Date of the last object modification
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"{ "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 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
The IP Block specific to this ACL
The internal name of your dedicated server
Response
UUID of the change linked to this task
Details of this task
Completion date
Function name
INFRA_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/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDeletelast update
Whether this task need to be scheduled or not
Extra information about this task
ID of the planned intervention for this task
Task Creation date
Task status
cancelledcustomerErrordoingdoneinitovhErrortodoTask result tags output
the id of the task
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"{ "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
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
The IP Block specific to this ACL
The internal name of your dedicated server
Request body (required)
Whether to allow the CIFS (SMB) protocol for this ACL
Whether to allow the FTP protocol for this ACL
The IP Block specific to this ACL
Whether the rule has been applied on the Backup Ftp
Date of the last object modification
Whether to allow the NFS protocol for this ACL
Response
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"Reset the backup FTP passwordProduction
Reset the backup FTP password. Resets the backup FTP password and returns a task. The response does not contain the new password.
Path parameters
The internal name of your dedicated server
Response
UUID of the change linked to this task
Details of this task
Completion date
Function name
INFRA_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/configureSGXmigrateBackupFTPmoveFloatingIpmoveVirtualMacreagregateBlockrebootPower8ToreinstallServerreleaseIpremoveBackupFTPremoveVirtualMacrequestAccessIPMIresetIPMIresetIPMISessiontestIPMIhttptestIPMIpasswordtestIPMIpingvirtualMacAddvirtualMacDeletelast update
Whether this task need to be scheduled or not
Extra information about this task
ID of the planned intervention for this task
Task Creation date
Task status
cancelledcustomerErrordoingdoneinitovhErrortodoTask result tags output
the id of the task
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"{ "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 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
The internal name of your dedicated server
Response
Archive container max size.
Archive volume r/w bandwidth limit: read/write volume offered per month on the container.
Storage volume r/w bandwidth limit: read/write volume offered per month on the container.
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"{ "maxArchive": { "unit": "string", "value": 0 }, "maxBandwidthArchive": { "unit": "string", "value": 0 }, "maxBandwidthStorage": { "unit": "string", "value": 0 }, "maxStorage": { "unit": "string", "value": 0 }}