Instance Backups - Backup Instance

Service:

Online Management API Reference

API Version:

v1.4

Backs up a Dataverse environment. This API is deprecated.
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		AzureStorage	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	OperationStatus	Backup operation started. Media Types: "application/json", "text/json"
400 Bad Request	OperationStatus	There was an issue either validating or starting the backup operation. Media Types: "application/json", "text/json"

Definitions

Name	Description
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

Object

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

Object

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

Object

Name	Type	Description
AzureStorageInformation	AzureStorage	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

Object

The operation context object

Name	Type	Description
Items	object	The item object

OperationState

Enumeration

State of the operation

Value	Description
None
FailedToCreate
NotStarted
Ready
Pending
Running
Succeeded
Failed
Cancelling
Cancelled
Aborting
Aborted
Tombstone
Deleting
Deleted
NotFound
Conflict

OperationStatus

Object

Status of the operation

Name	Type	Description
Context	OperationContext	The operation context object
Errors	ItemDescription[]	Set of values to display errors during an operation
Information	ItemDescription[]	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	OperationState	State of the operation