Zerto

All operations require authentication.

24 operationsv1/dedicatedCloud/{serviceName}

OpenAPI

Agent setup

Disable Zerto disaster recovery between two VMware on OVHcloud infrastructuresProduction

POST

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/disable

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Request body (required)

secondaryDatacenterId

required

integer

Your secondary datacenter id

secondaryServiceName

required

string

Your secondary dedicatedCloud

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/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/disable \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}

Enable Zerto disaster recovery between two VMware on OVHcloud infrastructuresDeprecated

POST

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/enable

Deprecated since May 31, 2019, will be removed on Jun 30, 2019 — use /order/cart/{cartId}/privateCloud instead.

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Request body (required)

primaryEndpointIp

required

Your primary OVH VMware on OVHcloud public IP for the secured replication data tunnel endpoint

secondaryDatacenterId

required

integer

Your secondary datacenter id

secondaryEndpointIp

required

Your secondary OVH VMware on OVHcloud public IP for the secured replication data tunnel endpoint

secondaryServiceName

required

string

Your secondary OVH VMware on OVHcloud

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/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/enable \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}

Unlink migration source virtual datacenter from Zerto disaster recoveryProduction

POST

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/endMigration

Path parameters

datacenterId

required

integer

Id of the Datacenter

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, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/endMigration \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}

Change the IP address used by Zerto disaster recovery endpoint for public network accessProduction

POST

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/endpointPublicIp

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Request body (required)

newEndpointPublicIp

required

Your new public IP for the secured replication data tunnel endpoint

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/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/endpointPublicIp \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}

List Zerto disaster recovery remote sitesProduction

GET

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/remoteSites

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Response

200ZertoRemoteVra[]successful operation

integer

ID of the remote Vra Network

label

string

Name given to this network

remoteEndpointPublicIp

Your onsite endpoint public IP for the secured replication data tunnel

remoteVraNetwork

ipBlock

Internal zerto subnet of your onsite infrastructure (ip/cidr)

remoteZvmInternalIp

Internal ZVM ip on your onsite infrastructure local network

state

StateEnum

Current state of your current Zerto remote site

ValuescreatingdeletingdeliverederrortoCreatetoDeletetoUpdateunknownupdating

Example uses datacenterId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/remoteSites \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1[2  {3    "id": 0,4    "label": "string",5    "remoteEndpointPublicIp": "192.0.2.0",6    "remoteVraNetwork": "192.0.2.0/24",7    "remoteZvmInternalIp": "192.0.2.0",8    "state": "creating"9  }10]

Create Zerto disaster recovery remote site on VPN endpointProduction

POST

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/remoteSites

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Request body (required)

label

required

string

The name for this connection

preSharedKey

required

stringpassword

Pre-Shared Key to secure data transfer between both sites

remoteEndpointPublicIp

required

ipv4

Your onsite endpoint public IP for the secured replication data tunnel

remoteVraNetwork

required

ipv4Block

Internal zerto subnet of your onsite infrastructure (ip/cidr)

remoteZvmInternalIp

required

ipv4

Internal ZVM ip of your onsite infrastructure

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/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/remoteSites \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}

Remove Zerto disaster recovery remote siteProduction

DELETE

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/remoteSites

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Query parameters

required

integer

The id number of the network to remove (as returned by a GET call)

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/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/remoteSites \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}

Run Zerto disaster recovery health check taskProduction

POST

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/requestHealthCheck

Path parameters

datacenterId

required

integer

Id of the Datacenter

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, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/requestHealthCheck \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}

Link migration target virtual datacenter to Zerto disaster recoveryProduction

POST

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/startMigration

Path parameters

datacenterId

required

integer

Id of the Datacenter

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, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/startMigration \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}

Get Zerto disaster recovery option statusProduction

GET

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/status

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Response

200Profilesuccessful operation

drpType

DrpTypeEnum

Disaster Recovery Plan Type

ValuesonPremiseovh

localSiteInformation

LocalSiteDetails

Information about the site installed on this Dedicated Cloud

remoteSiteInformation

RemoteSiteDetails

Deprecated - Information about the first remote paired site

remoteSitesInformation

RemoteSiteDetails[]

Information about the remote paired sites

state

StateEnum

State of the disaster recovery service

ValuesavailabledelivereddisableddisablingerrormigratingprovisionningrecyclingreservedtoDisabletoProvisiontoRecycletoRemovetoUnprovisionunprovisionningupgrading

systemVersion

string

Technical solution used

Example uses datacenterId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/status \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "drpType": "onPremise",3  "localSiteInformation": {4    "endpointPublicIp": "192.0.2.0",5    "role": "primary",6    "state": "available",7    "type": "onPremise",8    "vraNetwork": "192.0.2.0/24",9    "zertoVersion": "string",10    "zvmIp": "192.0.2.0"11  },12  "remoteSiteInformation": {13    "datacenterId": 0,14    "datacenterName": "string",15    "lastVpnConfig": "2024-01-01T12:00:00Z",16    "remoteEndpointInternalIp": "192.0.2.0",17    "remoteEndpointPublicIp": "192.0.2.0",18    "remoteZvmInternalIp": "192.0.2.0",19    "role": "primary",20    "serviceName": "string",21    "state": "available",22    "type": "onPremise",23    "vpnConfigState": "configured",24    "vraNetwork": "192.0.2.0/24",25    "zertoVersion": "string"26  },27  "remoteSitesInformation": [28    {29      "datacenterId": 0,30      "datacenterName": "string",31      "lastVpnConfig": "2024-01-01T12:00:00Z",32      "remoteEndpointInternalIp": "192.0.2.0",33      "remoteEndpointPublicIp": "192.0.2.0",34      "remoteZvmInternalIp": "192.0.2.0",35      "role": "primary",36      "serviceName": "string",37      "state": "available",38      "type": "onPremise",39      "vpnConfigState": "configured",40      "vraNetwork": "192.0.2.0/24",41      "zertoVersion": "string"42    }43  ],44  "state": "available",45  "systemVersion": "string"46}

List Zerto disaster recovery protected virtual machinesProduction

GET

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/usageReport

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Query parameters

month

required

integer

Billing month

year

required

integer

Billing year

Response

200ZertoProtectedVm[]successful operation

fromDate

stringdate-time

Start of the backup for the requested period

protectedSite

string

Name of the site in which the VM is running

recoverySite

string

Name of the site where the VM is backed up

vmId

string

ID of the protected VM

vmName

string

Name of the protected VM

vpgName

string

Name of the virtual protection group in which the VM is located

Example uses datacenterId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/usageReport \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1[2  {3    "fromDate": "2024-01-01T12:00:00Z",4    "protectedSite": "string",5    "recoverySite": "string",6    "vmId": "string",7    "vmName": "string",8    "vpgName": "string"9  }10]

Lists all Zerto VRAs along with their allocated CPU and RAM resourcesProduction

GET

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/vraResources

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Response

200ZertoVrasResource[]successful operation

cpu

integer

Number of CPUs of VRA VM

memory

integer

Memory of VRA vm in GB

vmId

integer

ID of the Vra

vraName

string

Name of the VRA VM

Example uses datacenterId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/vraResources \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1[2  {3    "cpu": 0,4    "memory": 0,5    "vmId": 0,6    "vraName": "string"7  }8]

Updates the CPU and RAM resources allocated to a specified Zerto VRAProduction

POST

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/vraResources

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Request body (required)

resourcesSize

required

ZertoVraResourceSizeEnum

The desired CPU and RAM configuration for the VRA

ValuesLSXLXS

vmId

required

integer

The unique identifier of the VRA vm

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/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zerto/vraResources \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}

Configure VPN for Zerto disaster recovery between VMware on OVHcloud infrastructure and onsite infrastructureDeprecated

POST

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/configureVpn

Deprecated since Sep 14, 2025, will be removed on Jan 14, 2026 — use /dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/remoteSites instead.

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Request body (required)

preSharedKey

required

stringpassword

Pre-Shared Key to secure data transfer between both sites

remoteEndpointInternalIp

required

ipv4

Your onsite endpoint internal IP for the secured replication data tunnel

remoteEndpointPublicIp

required

ipv4

Your onsite endpoint public IP for the secured replication data tunnel

remoteVraNetwork

ipv4Block

Internal zerto subnet of your onsite infrastructure (ip/cidr)

remoteZvmInternalIp

required

ipv4

Internal ZVM ip of your onsite infrastructure

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/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/configureVpn \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}

Get Zerto disaster recovery default suggested local VRA subnetProduction

GET

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/defaultLocalVraNetwork

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Response

200ipv4Blocksuccessful operation

Example uses datacenterId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/defaultLocalVraNetwork \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1"192.0.2.0/24"

Disable Zerto disaster recovery between VMware on OVHcloud infrastructure and onsite infrastructureProduction

POST

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/disable

Path parameters

datacenterId

required

integer

Id of the Datacenter

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, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/disable \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}

Enable Zerto disaster recovery between VMware on OVHcloud infrastructure and onsite infrastructureDeprecated

POST

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/enable

Deprecated since May 31, 2019, will be removed on Jun 30, 2019 — use /order/cart/{cartId}/privateCloud instead.

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Request body (required)

localVraNetwork

required

ipBlock

Internal zerto subnet for your OVH VMware on OVHcloud (ip/cidr)

ovhEndpointIp

required

Your OVH VMware on OVHcloud public IP for the secured replication data tunnel endpoint

remoteVraNetwork

ipBlock

Deprecated - Internal zerto subnet of your onsite infrastructure (ip/cidr)

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/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/enable \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}

Change the IP address used by Zerto disaster recovery endpoint for public network accessProduction

POST

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/endpointPublicIp

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Request body (required)

newEndpointPublicIp

required

Your new public IP on your VMware on OVHcloud for the secured replication data tunnel endpoint

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/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/endpointPublicIp \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}

List Zerto disaster recovery remote sitesProduction

GET

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/remoteSites

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Response

200ZertoRemoteVra[]successful operation

integer

ID of the remote Vra Network

label

string

Name given to this network

remoteEndpointPublicIp

Your onsite endpoint public IP for the secured replication data tunnel

remoteVraNetwork

ipBlock

Internal zerto subnet of your onsite infrastructure (ip/cidr)

remoteZvmInternalIp

Internal ZVM ip on your onsite infrastructure local network

state

StateEnum

Current state of your current Zerto remote site

ValuescreatingdeletingdeliverederrortoCreatetoDeletetoUpdateunknownupdating

Example uses datacenterId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/remoteSites \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1[2  {3    "id": 0,4    "label": "string",5    "remoteEndpointPublicIp": "192.0.2.0",6    "remoteVraNetwork": "192.0.2.0/24",7    "remoteZvmInternalIp": "192.0.2.0",8    "state": "creating"9  }10]

Create Zerto disaster recovery remote site on VPN endpointProduction

POST

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/remoteSites

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Request body (required)

label

required

string

The name for this connection

preSharedKey

required

stringpassword

Pre-Shared Key to secure data transfer between both sites

remoteEndpointPublicIp

required

ipv4

Your onsite endpoint public IP for the secured replication data tunnel

remoteVraNetwork

required

ipv4Block

Internal zerto subnet of your onsite infrastructure (ip/cidr)

remoteZvmInternalIp

required

ipv4

Internal ZVM ip of your onsite infrastructure

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/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/remoteSites \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}

Remove Zerto disaster recovery remote siteProduction

DELETE

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/remoteSites

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Query parameters

required

integer

The id number of the network to remove (as returned by a GET call)

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/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/remoteSites \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}

Request Zerto disaster recovery pairing token for onsite infrastructureProduction

POST

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/requestPairingToken

Path parameters

datacenterId

required

integer

Id of the Datacenter

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, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/requestPairingToken \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}

Lists all Zerto VRAs along with their allocated CPU and RAM resourcesProduction

GET

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/vraResources

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Response

200ZertoVrasResource[]successful operation

cpu

integer

Number of CPUs of VRA VM

memory

integer

Memory of VRA vm in GB

vmId

integer

ID of the Vra

vraName

string

Name of the VRA VM

Example uses datacenterId = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/vraResources \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1[2  {3    "cpu": 0,4    "memory": 0,5    "vmId": 0,6    "vraName": "string"7  }8]

Updates the CPU and RAM resources allocated to a specified Zerto VRAProduction

POST

/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/vraResources

Path parameters

datacenterId

required

integer

Id of the Datacenter

serviceName

required

string

Domain of the service

Request body (required)

resourcesSize

required

ZertoVraResourceSizeEnum

The desired CPU and RAM configuration for the VRA

ValuesLSXLXS

vmId

required

integer

The unique identifier of the VRA vm

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/1.0/dedicatedCloud/{serviceName}/datacenter/{datacenterId}/disasterRecovery/zertoSingle/vraResources \
  -H "authorization: Bearer $OVH_TOKEN"

ResponseExample

1{2  "createdBy": "string",3  "createdFrom": "string",4  "datacenterId": 0,5  "description": "string",6  "endDate": "2024-01-01T12:00:00Z",7  "executionDate": "2024-01-01T12:00:00Z",8  "filerId": 0,9  "hostId": 0,10  "lastModificationDate": "2024-01-01T12:00:00Z",11  "maintenanceDateFrom": "2024-01-01T12:00:00Z",12  "maintenanceDateTo": "2024-01-01T12:00:00Z",13  "name": "string",14  "network": "string",15  "networkAccessId": 0,16  "orderId": 0,17  "parentTaskId": 0,18  "progress": 0,19  "state": "canceled",20  "taskId": 0,21  "type": "string",22  "userId": 0,23  "vlanId": 024}