Instances - Get Instances

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

GET {ServiceUrl}/api/v1.2/Instances

Responses

Name	Type	Description
200 OK	Instance[]	List of Dataverse environments retrieved from your Office 365 tenant. Media Types: "application/json", "text/json"

Name

Type

Description

200 OK

List of Dataverse environments retrieved from your Office 365 tenant.

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

Name	Description
Instance	A representation of an environment
InstanceState	State of the instance
InstanceType	The type of instance
ProtectionStatus	Indicated whether the instance is Microsoft or Tenant encrypted

A representation of an environment

Name	Type	Description
AdditionalProperties	object
AdminMode	boolean	Indicates whether the instance is in admin mode
ApiUrl	string	URL of the Web API for the instance
ApplicationUrl	string	URL to the web application of the instance
BaseLanguage	integer	Base language code for the instance
DomainName	string	Public domain name of the instance.
FriendlyName	string	Friendly name of the instance
Id	string	ID of the instance
InitialUserEmail	string	The object id of the user that created the instance
InitialUserPrincipalName	string	UserPrincipalName of the initial user
IsLocked	boolean	Indicates whether the instance is locked
ProtectionStatus	ProtectionStatus	Indicated whether the instance is Microsoft or Tenant encrypted
Purpose	string	Purpose of the instance
SecurityGroupId	string	Security group set for the instance.
State	InstanceState	State of the instance
StateIsSupportedForDelete	boolean	Indicates whether the instance can be deleted
Type	InstanceType	The type of instance
UniqueName	string	Unique name of the instance
Version	string	Version of the instance

State of the instance

The type of instance

Indicated whether the instance is Microsoft or Tenant encrypted

Name	Type	Description
MicrosoftEncrypted	string
TenantEncrypted	string