Managed Veeam for Public VCF aaS
All operations require authentication.
List backup tasksProduction
Returns the asynchronous tasks of the backup service.
Path parameters
Backup ID
Headers
Pagination cursor
Pagination size
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
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"[ { "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
Returns the backup services, with their offers and status.
Query parameters
Filter resources on IAM tags
Headers
Pagination cursor
Pagination size
Response
Datetime when backup was enabled
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the VMware Cloud Director organization backup service
IAM resource metadata
Unique identifier of the VMware Cloud Director backup
Reflects the readiness of the VMware Cloud Director organization backup service. A new target specification request will be accepted only in READY status.
CREATINGDISABLEDDISABLINGREADYREMOVEDREMOVINGUPDATINGConfiguration you requested. While a change is still being applied it differs from currentState.
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"[ { "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
Returns the backup service: offers with their quota and used space, availability zone and status.
Path parameters
Backup ID
Response
Datetime when backup was enabled
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the VMware Cloud Director organization backup service
IAM resource metadata
Unique identifier of the VMware Cloud Director backup
Reflects the readiness of the VMware Cloud Director organization backup service. A new target specification request will be accepted only in READY status.
CREATINGDISABLEDDISABLINGREADYREMOVEDREMOVINGUPDATINGConfiguration you requested. While a change is still being applied it differs from currentState.
Datetime when backup is modified
Example uses backupId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ vmwareCloudDirector/ backup/ {backupId} \
-H "authorization: Bearer $OVH_TOKEN"{ "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
Returns the task: type, status, progress steps, errors and dates.
Path parameters
Backup ID
Task ID
Response
Creation date of the task
Errors that occurred on the task
Ending date of the task
Unique identifier of the task
Link to the related resource
Description of the task
Progress steps of the asynchronous operation
Starting date of the task
Current global status of the task
DONEERRORPENDINGRUNNINGSCHEDULEDWAITING_USER_INPUTType of the task
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"{ "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
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
Backup ID
Request body (required)
New target specification for the VMware Cloud Director organization backup service and offers
Response
Datetime when backup was enabled
Configuration currently in force on the platform. It catches up with targetSpec once the requested change has been applied.
Asynchronous operations ongoing on the VMware Cloud Director organization backup service
Unique identifier of the VMware Cloud Director backup
Reflects the readiness of the VMware Cloud Director organization backup service. A new target specification request will be accepted only in READY status.
CREATINGDISABLEDDISABLINGREADYREMOVEDREMOVINGUPDATINGConfiguration you requested. While a change is still being applied it differs from currentState.
Datetime when backup is modified
Example uses backupId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ vmwareCloudDirector/ backup/ {backupId} \
-H "authorization: Bearer $OVH_TOKEN"{ "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"}