Instance Backups - Backup Instance

Backs up a Common Data Service environment.
For a list of region-specific service URLs, see Service URL

POST {ServiceUrl}/api/v1.2/InstanceBackups

Request Body

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

Name Required Type Description
InstanceId True
  • string

ID of the instance to backup.

Label True
  • string

Label to help identify this backup for future restoration.

AzureStorageInformation

For internal use only. Azure storage is not supported.

IsAzureBackup
  • boolean

For internal use only.

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

For internal use only. Azure storage is not supported.

ItemDescription

Set of values to define an error or information item

NewInstanceBackup
OperationContext

The operation context object

OperationState

State of the operation

OperationStatus

Status of the operation

AzureStorage

For internal use only. Azure storage is not supported.

Name Type Description
ContainerName
  • string

For internal use only.

StorageAccountKey
  • string

For internal use only.

StorageAccountName
  • string

For internal use only.

ItemDescription

Set of values to define an error or information item

Name Type Description
Code
  • string

Code of the item

Description
  • string

Description of the item

Subject
  • string

Subject of the item

NewInstanceBackup

Name Type Description
AzureStorageInformation

For internal use only. Azure storage is not supported.

InstanceId
  • string

ID of the instance to backup.

IsAzureBackup
  • boolean

For internal use only.

Label
  • string

Label to help identify this backup for future restoration.

Notes
  • string

Notes to help identify this backup for future restoration.

OperationContext

The operation context object

Name Type Description
Items
  • object

The item object

OperationState

State of the operation

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

OperationStatus

Status of the operation

Name Type Description
Context

The operation context object

Errors

Set of values to display errors during an operation

Information

Set of values to display information during an operation

OperationId
  • string

ID of the operation

OperationLocation
  • string

Location of the operation

ResourceLocation
  • string

Location of the resource

Status

State of the operation