Skip to content

Managed Veeam for Public VCF aaS

All operations require authentication.

5 operationsv2/vmwareCloudDirector/backup
Agent setup

List backup tasksProduction

GET
/v2/vmwareCloudDirector/backup/{backupId}/task

Returns the asynchronous tasks of the backup service.

Path parameters

backupId
required
string

Backup ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Task[]successful operation
createdAt
read-only
stringdate-time

Creation date of the task

errors
read-only
TaskError[]

Errors that occurred on the task

finishedAt
read-only
stringdate-time

Ending date of the task

id
read-only
stringuuid

Unique identifier of the task

link
read-only
string

Link to the related resource

message
read-only
string

Description of the task

progress
read-only
TaskProgress[]

Progress steps of the asynchronous operation

startedAt
read-only
stringdate-time

Starting date of the task

status
read-only
TaskStatusEnum

Current global status of the task

ValuesDONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUT
type
read-only
string

Type of the task

updatedAt
read-only
stringdate-time

Last update of the task

Example uses backupId = string

$ curl https://api.eu.ovhcloud.com/v2/vmwareCloudDirector/backup/{backupId}/task \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z" }]

List backup servicesProduction

GET
/v2/vmwareCloudDirector/backup

Returns the backup services, with their offers and status.

Query parameters

iamTags
object

Filter resources on IAM tags

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200BackupDetailsWithIAM[]successful operation
createdAt
read-only
stringdate-time

Datetime when backup was enabled

currentState
read-only
CurrentState

Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.

currentTasks
read-only
CurrentTask[]

Asynchronous operations ongoing on the VMware Cloud Director organization backup service

iam
read-only
ResourceMetadata

IAM resource metadata

id
read-only
string

Unique identifier of the VMware Cloud Director backup

resourceStatus
read-only
BackupResourceStatusEnum

Reflects the readiness of the VMware Cloud Director organization backup service. A new target specification request will be accepted only in READY status.

ValuesCREATINGDISABLEDDISABLINGREADYREMOVEDREMOVINGUPDATING
targetSpec
read-only
TargetSpec

Configuration you requested. While a change is still being applied it differs from currentState.

updatedAt
read-only
stringdate-time

Datetime when backup is modified

Reads your token from $OVH_TOKEN

$ curl https://api.eu.ovhcloud.com/v2/vmwareCloudDirector/backup \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "createdAt": "2024-01-01T12:00:00Z", "currentState": { "azName": "ca-east-bhs-a", "offers": [ { "name": "BRONZE", "protectionPrimaryRegion": "ap-south-mum", "protectionReplicatedRegion": "ap-south-mum", "quotaInTB": 0, "status": "CREATING", "usedSpaceInGB": 0 } ] }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "id": "string", "resourceStatus": "CREATING", "targetSpec": { "offers": [ { "name": "BRONZE", "quotaInTB": 0 } ] }, "updatedAt": "2024-01-01T12:00:00Z" }]

Get a backup serviceProduction

GET
/v2/vmwareCloudDirector/backup/{backupId}

Returns the backup service: offers with their quota and used space, availability zone and status.

Path parameters

backupId
required
string

Backup ID

Response

200BackupDetailsWithIAMsuccessful operation
createdAt
read-only
stringdate-time

Datetime when backup was enabled

currentState
read-only
CurrentState

Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.

currentTasks
read-only
CurrentTask[]

Asynchronous operations ongoing on the VMware Cloud Director organization backup service

iam
read-only
ResourceMetadata

IAM resource metadata

id
read-only
string

Unique identifier of the VMware Cloud Director backup

resourceStatus
read-only
BackupResourceStatusEnum

Reflects the readiness of the VMware Cloud Director organization backup service. A new target specification request will be accepted only in READY status.

ValuesCREATINGDISABLEDDISABLINGREADYREMOVEDREMOVINGUPDATING
targetSpec
read-only
TargetSpec

Configuration you requested. While a change is still being applied it differs from currentState.

updatedAt
read-only
stringdate-time

Datetime when backup is modified

Example uses backupId = string

$ curl https://api.eu.ovhcloud.com/v2/vmwareCloudDirector/backup/{backupId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdAt": "2024-01-01T12:00:00Z", "currentState": { "azName": "ca-east-bhs-a", "offers": [ { "name": "BRONZE", "protectionPrimaryRegion": "ap-south-mum", "protectionReplicatedRegion": "ap-south-mum", "quotaInTB": 0, "status": "CREATING", "usedSpaceInGB": 0 } ] }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "id": "string", "resourceStatus": "CREATING", "targetSpec": { "offers": [ { "name": "BRONZE", "quotaInTB": 0 } ] }, "updatedAt": "2024-01-01T12:00:00Z"}

Get a backup taskProduction

GET
/v2/vmwareCloudDirector/backup/{backupId}/task/{taskId}

Returns the task: type, status, progress steps, errors and dates.

Path parameters

backupId
required
string

Backup ID

taskId
required
stringuuid

Task ID

Response

200Tasksuccessful operation
createdAt
read-only
stringdate-time

Creation date of the task

errors
read-only
TaskError[]

Errors that occurred on the task

finishedAt
read-only
stringdate-time

Ending date of the task

id
read-only
stringuuid

Unique identifier of the task

link
read-only
string

Link to the related resource

message
read-only
string

Description of the task

progress
read-only
TaskProgress[]

Progress steps of the asynchronous operation

startedAt
read-only
stringdate-time

Starting date of the task

status
read-only
TaskStatusEnum

Current global status of the task

ValuesDONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUT
type
read-only
string

Type of the task

updatedAt
read-only
stringdate-time

Last update of the task

Example uses backupId = string, taskId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/vmwareCloudDirector/backup/{backupId}/task/{taskId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdAt": "2024-01-01T12:00:00Z", "errors": [ { "message": "string" } ], "finishedAt": "2024-01-01T12:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "link": "string", "message": "string", "progress": [ { "name": "string", "status": "DONE" } ], "startedAt": "2024-01-01T12:00:00Z", "status": "DONE", "type": "string", "updatedAt": "2024-01-01T12:00:00Z"}

Update a backup serviceProduction

PUT
/v2/vmwareCloudDirector/backup/{backupId}

Replaces the backup offers of the service: BRONZE, SILVER or GOLD, each with a quota in TB. An offer left out of the list is removed. Accepted only when the service is READY, then applied asynchronously: currentState catches up with targetSpec.

Path parameters

backupId
required
string

Backup ID

Request body (required)

targetSpec
required
TargetSpec

New target specification for the VMware Cloud Director organization backup service and offers

Response

200BackupDetailssuccessful operation
createdAt
read-only
stringdate-time

Datetime when backup was enabled

currentState
read-only
CurrentState

Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.

currentTasks
read-only
CurrentTask[]

Asynchronous operations ongoing on the VMware Cloud Director organization backup service

id
read-only
string

Unique identifier of the VMware Cloud Director backup

resourceStatus
read-only
BackupResourceStatusEnum

Reflects the readiness of the VMware Cloud Director organization backup service. A new target specification request will be accepted only in READY status.

ValuesCREATINGDISABLEDDISABLINGREADYREMOVEDREMOVINGUPDATING
targetSpec
read-only
TargetSpec

Configuration you requested. While a change is still being applied it differs from currentState.

updatedAt
read-only
stringdate-time

Datetime when backup is modified

Example uses backupId = string

$ curl https://api.eu.ovhcloud.com/v2/vmwareCloudDirector/backup/{backupId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "createdAt": "2024-01-01T12:00:00Z", "currentState": { "azName": "ca-east-bhs-a", "offers": [ { "name": "BRONZE", "protectionPrimaryRegion": "ap-south-mum", "protectionReplicatedRegion": "ap-south-mum", "quotaInTB": 0, "status": "CREATING", "usedSpaceInGB": 0 } ] }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "string", "resourceStatus": "CREATING", "targetSpec": { "offers": [ { "name": "BRONZE", "quotaInTB": 0 } ] }, "updatedAt": "2024-01-01T12:00:00Z"}