Instance Backups - Backup Instance

Backs up a Customer Engagement instance. For a list of region-specific service URLs, see Service URL

POST {ServiceUrl}/api/v1/InstanceBackups

Request Body

Media Types: "application/json", "text/json"

Name Required Type Description
AzureStorageInformation
InstanceId True
  • string

ID of the instance to backup.

IsAzureBackup
  • boolean

Indicates whether you want to backup the instance to Azure Storage.

Label True
  • string

Label to help identify this backup for future restoration.

Notes
  • string

Notes to help identify this backup for future restoration.

Responses

Name Type Description
202 Accepted

Backup operation started.

Media Types: "application/json", "text/json"

400 Bad Request

There was an issue either validating or starting the backup operation.

Media Types: "application/json", "text/json"

Definitions

AzureStorage
ItemDescription
NewInstanceBackup
OperationContext
OperationState
OperationStatus

AzureStorage

Name Type Description
ContainerName
  • string

Container in Azure Storage where you want to back up the instance.

StorageAccountKey
  • string

Azure Storage account key to authenticate to the file share for backing up.

StorageAccountName
  • string

Azure Storage account name where want to back up the instance.

ItemDescription

Name Type Description
Description
  • string
Subject
  • string

NewInstanceBackup

Name Type Description
AzureStorageInformation
InstanceId
  • string

ID of the instance to backup.

IsAzureBackup
  • boolean

Indicates whether you want to backup the instance to Azure Storage.

Label
  • string

Label to help identify this backup for future restoration.

Notes
  • string

Notes to help identify this backup for future restoration.

OperationContext

Name Type Description
Items
  • <string, object>

OperationState

Name Type Description
Aborted
  • string
Aborting
  • string
Cancelled
  • string
Cancelling
  • string
Deleted
  • string
Deleting
  • string
Failed
  • string
FailedToCreate
  • string
None
  • string
NotStarted
  • string
Pending
  • string
Ready
  • string
Running
  • string
Succeeded
  • string
Tombstone
  • string

OperationStatus

Name Type Description
Context
Errors
Information
OperationId
  • string

ID of the backup operation.

OperationLocation
  • string
ResourceLocation
  • string
Status