Instances - Delete Instance

Service:

Online Management API Reference

API Version:

v1.4

Deletes a Dataverse environment in your Office 365 tenant. This API is deprecated.
For a list of region-specific service URLs, see Service URL

DELETE {ServiceUrl}/api/v1.2/Instances/{id}/Delete

With optional parameters:

DELETE {ServiceUrl}/api/v1.2/Instances/{id}/Delete?validate={validate}

URI Parameters

Name	In	Required	Type	Description
id	path	True	string (uuid)	ID of the Dataverse environment to delete.
validate	query		boolean	Indicates whether to validate or delete an instance. Set True to validate; set False to delete.

Responses

Name	Type	Description
200 OK	OperationStatus	If validate was set, validation was executed. Media Types: "application/json", "text/json"
202 Accepted	OperationStatus	Delete Instance Operation Started. Media Types: "application/json", "text/json"
400 Bad Request	OperationStatus	There was an issue either validating or starting the delete operation. Media Types: "application/json", "text/json"
404 Not Found		NotFound Media Types: "application/json", "text/json"

Definitions

Name	Description
ItemDescription	Set of values to define an error or information item
OperationContext	The operation context object
OperationState	State of the operation
OperationStatus	Status of the operation

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

OperationContext

Object

The operation context object

Name	Type	Description
Items	object	The item object

OperationState

Enumeration

State of the operation

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

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