Instances - Get Instances

Retrieves all Common Data Service environments in your Office 365 tenant.
For a list of region-specific service URLs, see Service URL

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

Responses

Name Type Description
200 OK

List of Common Data Service environments retrieved from your Office 365 tenant.

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

Definitions

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

Instance

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

Indicated whether the instance is Microsoft or Tenant encrypted

Purpose
  • string

Purpose of the instance

SecurityGroupId
  • string

Security group set for the instance.

State

State of the instance

StateIsSupportedForDelete
  • boolean

Indicates whether the instance can be deleted

Type

The type of instance

UniqueName
  • string

Unique name of the instance

Version
  • string

Version of the instance

InstanceState

State of the instance

Name Type Description
Disabled
  • string
FailedProvisioning
  • string
Inactive
  • string
Locked
  • string
None
  • string
Pending
  • string
PreparingInstance
  • string
Ready
  • string
ReadyToConfigure
  • string

InstanceType

The type of instance

Name Type Description
Default
  • string
Developer
  • string
None
  • string
Preview
  • string
Production
  • string
Sandbox
  • string
Support
  • string
Trial
  • string

ProtectionStatus

Indicated whether the instance is Microsoft or Tenant encrypted

Name Type Description
MicrosoftEncrypted
  • string
TenantEncrypted
  • string