Microsoft Fabric Tags API
The Tags API from Microsoft Fabric — 5 operation(s) for tags.
The Tags API from Microsoft Fabric — 5 operation(s) for tags.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/microsoft-fabric:microsoft-fabric-tags-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Microsoft Fabric Tags API
version: v1
x-refined-note:
- x-source differs across the merged source definitions and was not carried
description: 'Operations tagged Tags across 2 of this provider''s published API definitions: microsoft-fabric-admin-openapi.yml, microsoft-fabric-platform-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.fabric.microsoft.com/v1/admin
- url: https://api.fabric.microsoft.com/v1
security: []
tags:
- name: Tags
paths:
/tags:
get:
summary: Returns a list of all the tenant's tags
description: '## Required Delegated Scopes
Tenant.Read.All or 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'
tags:
- Tags
operationId: Tags_ListTags
x-ms-pageable:
nextLinkName: continuationUri
parameters:
- in: query
name: continuationToken
description: A token for retrieving the next page of results.
required: false
schema:
type: string
responses:
'200':
description: The request was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/AdminTagsInfo'
'429':
description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
x-ms-error-response: true
headers:
Retry-After:
description: The number of seconds to wait before retrying the request.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
default:
description: 'Common error codes:
* UnknownError - An error occurred'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://api.fabric.microsoft.com/v1/admin
/tags/bulkCreateTags:
post:
summary: Create new tags
description: '## Permissions
The caller must have administrator rights such as 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'
tags:
- Tags
operationId: Tags_BulkCreateTags
responses:
'201':
description: Tags created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTagsResponse'
'429':
description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
x-ms-error-response: true
headers:
Retry-After:
description: The number of seconds to wait before retrying the request.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
default:
description: "Common error codes:\n\n* UnknownError - An error occurred \n\n* InvalidInputs - Invalid input was provided \n\n* EntityConflict - Tag display name already exists \n\n* EntityNotFound - Domain ID does not exist"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTagsRequest'
description: The request payload for creating tags.
required: true
servers:
- url: https://api.fabric.microsoft.com/v1/admin
/tags/{tagId}:
delete:
summary: Delete the specified tag
description: '## Permissions
The caller must have administrator rights such as Fabric administrator.
## Required Delegated Scopes
Tenant.ReadWrite.All.
## Limitations
Maximum 10 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'
tags:
- Tags
operationId: Tags_DeleteTag
parameters:
- in: path
name: tagId
description: The tag ID.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Tag was deleted successfully.
'429':
description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
x-ms-error-response: true
headers:
Retry-After:
description: The number of seconds to wait before retrying the request.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
default:
description: "Common error codes:\n\n* UnknownError - An error occurred \n\n* EntityNotFound - Tag ID does not exist"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
patch:
summary: Updates the specified tag
description: '## Permissions
The caller must have administrator rights such as 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'
tags:
- Tags
operationId: Tags_UpdateTag
parameters:
- in: path
name: tagId
description: The tag ID.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Tag was updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Tag'
'429':
description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
x-ms-error-response: true
headers:
Retry-After:
description: The number of seconds to wait before retrying the request.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
default:
description: "Common error codes:\n\n* UnknownError - An error occurred\n\n* EntityNotFound - Tag ID does not exist \n\n* EntityConflict - Tag display name already exist\n\n * InvalidInput - Invalid tag display name"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTagRequest'
description: The request payload for updating the tag.
required: true
servers:
- url: https://api.fabric.microsoft.com/v1/admin
/workspaces/{workspaceId}/items/{itemId}/applyTags:
post:
summary: Apply tags on an item
description: '## Permissions
The caller must have *contributor* or higher role on the workspace.
## Required Delegated Scopes
ItemMetadata.ReadWrite.All or these scope types:
- Generic scope: Item.ReadWrite.All
- Specific scope: *itemType*.ReadWrite.All (for example: Notebook.ReadWrite.All)
For more information about scopes, see Scopes article.
## 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'
tags:
- Tags
operationId: Tags_ApplyTags
parameters:
- in: path
name: workspaceId
description: The workspace ID.
required: true
schema:
type: string
format: uuid
- in: path
name: itemId
description: The item ID.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Tags were applied successfully.
'429':
description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
x-ms-error-response: true
headers:
Retry-After:
description: The number of seconds to wait before retrying the request.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
default:
description: "Common error codes:\n\n* ItemNotFound - Indicates that the server cannot find the requested item \n\n* EntityNotFound - Tag ID does not exist \n\n* InvalidInputs - Invalid input was provided"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplyTagsRequest'
description: The request payload for applying tags.
required: true
servers:
- url: https://api.fabric.microsoft.com/v1
/workspaces/{workspaceId}/items/{itemId}/unapplyTags:
post:
summary: Unapply tags from an item
description: '## Permissions
The caller must have *contributor* or higher role on the workspace.
## Required Delegated Scopes
ItemMetadata.ReadWrite.All or these scope types:
- Generic scope: Item.ReadWrite.All
- Specific scope: *itemType*.ReadWrite.All (for example: Notebook.ReadWrite.All)
For more information about scopes, see Scopes article.
## 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'
tags:
- Tags
operationId: Tags_UnapplyTags
parameters:
- in: path
name: workspaceId
description: The workspace ID.
required: true
schema:
type: string
format: uuid
- in: path
name: itemId
description: The item ID.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Tags were unapplied successfully.
'429':
description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
x-ms-error-response: true
headers:
Retry-After:
description: The number of seconds to wait before retrying the request.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
default:
description: "Common error codes:\n\n* ItemNotFound - Indicates that the server cannot find the requested item \n\n* EntityNotFound - Tag ID does not exist \n\n* InvalidInputs - Invalid input was provided"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UnapplyTagsRequest'
description: The request payload for unapplying tags.
required: true
servers:
- url: https://api.fabric.microsoft.com/v1
components:
schemas:
ErrorResponse:
description: The error response.
required:
- message
- errorCode
allOf:
- $ref: '#/components/schemas/ErrorResponseDetails'
properties:
requestId:
type: string
format: uuid
description: ID of the request associated with the error.
readOnly: true
moreDetails:
description: List of additional error details.
type: array
items:
$ref: '#/components/schemas/ErrorResponseDetails'
readOnly: true
isRetriable:
type: boolean
description: When true, the request can be retried. Use the `Retry-After` response header to determine the delay, if available.
readOnly: true
CreateTagsResponse:
type: object
description: A response wrapper for a list of created tags.
required:
- tags
properties:
tags:
type: array
description: An array of tags
items:
$ref: '#/components/schemas/Tag'
Tag:
type: object
description: Represents a tag.
required:
- id
- displayName
- scope
properties:
id:
type: string
description: The tag object ID.
format: uuid
displayName:
type: string
description: The name of the tag.
scope:
$ref: '#/components/schemas/TagScope'
CreateTagsRequest:
type: object
required:
- createTagsRequest
description: This is a request wrapper for a creating a list of tags.
properties:
scope:
$ref: '#/components/schemas/TagScope'
createTagsRequest:
type: array
description: An array of createTagRequest
items:
$ref: '#/components/schemas/CreateTagRequest'
TagScope:
type: object
description: Represents a tag scope
discriminator:
propertyName: type
required:
- type
properties:
type:
description: Denotes tag scope. Additional tag scopes may be added over time.
type: string
enum:
- Tenant
- Domain
x-ms-enum:
name: TagScopeType
modelAsString: true
values:
- value: Tenant
description: Tag is a tenant level tag.
- value: Domain
description: Tag is a domain level tag.
readOnly: false
AdminTagInfo:
type: object
description: Represents a tag.
required:
- id
- displayName
- scope
properties:
id:
type: string
description: The tag object ID.
format: uuid
displayName:
type: string
description: The name of the tag.
scope:
$ref: '#/components/schemas/TagScope'
UpdateTagRequest:
type: object
required:
- displayName
description: The request payload for updating a tag.
properties:
displayName:
description: 'The tag display name.
The display name cannot contain more than 40 characters.'
type: string
readOnly: false
ErrorResponseDetails:
description: The error response details.
type: object
required:
- message
- errorCode
properties:
errorCode:
type: string
description: A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
readOnly: true
message:
type: string
description: A human readable representation of the error.
readOnly: true
relatedResource:
$ref: '#/components/schemas/ErrorRelatedResource'
parameters:
description: Structured parameters providing additional machine-readable context about the error.
type: array
items:
$ref: '#/components/schemas/ErrorParameter'
readOnly: true
ErrorRelatedResource:
description: The error related resource details object.
type: object
required:
- resourceId
- resourceType
properties:
resourceId:
type: string
description: The resource ID that's involved in the error.
readOnly: true
resourceType:
type: string
description: The type of the resource that's involved in the error.
readOnly: true
PaginatedResponse:
properties:
continuationToken:
type: string
description: The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri:
type: string
description: The URI of the next result set batch. If there are no more records, it's removed from the response.
CreateTagRequest:
type: object
required:
- displayName
description: The request payload for creating a tag.
properties:
displayName:
description: 'The tag display name.
The display name cannot contain more than 40 characters.'
type: string
readOnly: false
ErrorParameter:
description: A structured parameter providing additional machine-readable context about an error.
type: object
properties:
name:
type: string
description: The parameter identifier.
readOnly: true
value:
type: string
description: The parameter value.
readOnly: true
message:
type: string
description: A human-readable description of the parameter's meaning.
readOnly: true
AdminTagsInfo:
type: object
description: A response wrapper for a list of tags.
required:
- value
properties:
value:
type: array
description: An array of tags
items:
$ref: '#/components/schemas/AdminTagInfo'
allOf:
- $ref: '#/components/schemas/PaginatedResponse'
UnapplyTagsRequest:
type: object
required:
- tags
description: The request payload for unapplying tags.
properties:
tags:
description: The array of tag IDs.
type: array
items:
type: string
format: uuid
Tags:
type: object
description: A response wrapper for a list of tags.
required:
- value
properties:
value:
type: array
description: An array of tags
items:
$ref: '#/components/schemas/Tag'
allOf:
- $ref: '#/components/schemas/PaginatedResponse'
ApplyTagsRequest:
type: object
required:
- tags
description: The request payload for applying tags.
properties:
tags:
description: The array of tag IDs.
type: array
items:
type: string
format: uuid
x-refined-from:
- microsoft-fabric-admin-openapi.yml
- microsoft-fabric-platform-openapi.yml