Edit

Share via

Domains - Create Domain

Service:
Admin
API Version:
v1

Creates a new domain.

Note

This API is a release version of a preview version due to be deprecated on March 31, 2026. When calling this API - callers must set the query parameter preview to the value false

Permissions

The caller must be a Fabric administrator.

Required Delegated Scopes

Tenant.ReadWrite.All.

Limitations

Maximum 25 requests per one minute per principal.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities Yes

Interface

POST https://api.fabric.microsoft.com/v1/admin/domains?preview={preview}

URI Parameters

Name In Required Type Description
preview
 query True

boolean

This parameter specifies which version of the API to use. Set to false to use the release version.

Request Body

Name Required Type Description
displayName True

string

The domain display name. The display name cannot contain more than 40 characters.
description

string

The domain description. The description cannot contain more than 256 characters.
parentDomainId

string (uuid)

The domain parent object ID.

Responses

Name Type Description
201 Created

Domain

Domain created successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • EntityNotFound - Create domain failed because parent domain ID not found.

  • EntityConflict - Create domain failed because domain display name already exists.

  • InvalidInput - Invalid parent domain ID.

Examples

Create a domain example

Sample request

POST https://api.fabric.microsoft.com/v1/admin/domains?preview=false

{
  "displayName": "Finance",
  "description": "This domain is used for identifying financial data and reports.",
  "parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df"
}

Sample response

Status code:
201 
{
  "id": "9eba6944-daff-4441-b9b5-630ce34238fd",
  "displayName": "Finance",
  "description": "This domain is used for identifying financial data and reports.",
  "parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df"
}

Definitions

Name Description
CreateDomainRequest

The request payload for creating a domain or subdomain.
Domain
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.

CreateDomainRequest

Object

The request payload for creating a domain or subdomain.

Name Type Description
description

string

The domain description. The description cannot contain more than 256 characters.
displayName

string

The domain display name. The display name cannot contain more than 40 characters.
parentDomainId

string (uuid)

The domain parent object ID.

Domain

Object
Name Type Description
defaultLabelId

string (uuid)

The domain default sensitivity label.
description

string

The description of the domain.
displayName

string

The name of the domain.
id

string (uuid)

The domain object ID.
parentDomainId

string (uuid)

The domain parent object ID.

ErrorRelatedResource

Object

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string

ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
relatedResource

ErrorRelatedResource

The error related resource details.