Microsoft Fabric Table Shortcuts API
The TableShortcuts API from Microsoft Fabric — 2 operation(s) for tableshortcuts.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-fabric:microsoft-fabric-tableshortcuts-api"
All apis
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.
Get an API 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 Specification
openapi: 3.2.0
info:
title: Microsoft Fabric Workload Items REST Table Shortcuts API
version: v1
x-source: 'https://github.com/microsoft/fabric-rest-api-specs (bundled from openapi/_original/fabric-rest-api-specs: anomalyDetector/swagger.json, apacheAirflowJob/swagger.json, appBackend/swagger.json, azureDatabricksStorage/swagger.json, copyJob/swagger.json, cosmosDbDatabase/swagger.json, dashboard/swagger.json, dataAgent/swagger.json, dataBuildToolJob/swagger.json, dataPipeline/swagger.json, dataflow/swagger.json, datamart/swagger.json, deploymentPlan/swagger.json, digitalTwinBuilder/swagger.json, digitalTwinBuilderFlow/swagger.json, environment/swagger.json, eventSchemaSet/swagger.json, eventhouse/swagger.json, eventstream/swagger.json, graphModel/swagger.json, graphQLApi/swagger.json, graphQuerySet/swagger.json, kqlDashboard/swagger.json, kqlDatabase/swagger.json, kqlQueryset/swagger.json, lakehouse/swagger.json, map/swagger.json, mirroredAzureDatabricksCatalog/swagger.json, mirroredCatalog/swagger.json, mirroredDatabase/swagger.json, mirroredWarehouse/swagger.json, mlExperiment/swagger.json, mlModel/swagger.json, monitoring/swagger.json, mountedDataFactory/swagger.json, notebook/swagger.json, ontology/swagger.json, operationsAgent/swagger.json, orgApp/swagger.json, orgAppAudience/swagger.json, paginatedReport/swagger.json, plan/swagger.json, policySet/swagger.json, realTimeIntelligence/swagger.json, reflex/swagger.json, report/swagger.json, semanticModel/swagger.json, snowflakeDatabase/swagger.json, spark/swagger.json, sparkjobdefinition/swagger.json, sqlDatabase/swagger.json, sqlEndpoint/swagger.json, userDataFunction/swagger.json, variableLibrary/swagger.json, warehouse/swagger.json)'
servers:
- url: https://api.fabric.microsoft.com/v1
security: []
tags:
- name: TableShortcuts
paths:
/workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}/shortcuts:
get:
summary: Returns a list of all table shortcuts under a database
description: '## Permissions
The caller must have *read* permissions for the KQL database.
## Required Delegated Scopes
All of the below scopes are required:
- KQLDatabase.Read.All or KQLDatabase.ReadWrite.All or Item.Read.All or Item.ReadWrite.All
- OneLake.Read.All or OneLake.ReadWrite.All
## 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:
- TableShortcuts
operationId: TableShortcuts_ListShortcuts
x-ms-pageable:
nextLinkName: continuationUri
parameters:
- in: path
name: workspaceId
description: The workspace ID.
required: true
schema:
type: string
format: uuid
- in: path
name: kqlDatabaseId
description: The KQL database ID.
required: true
schema:
type: string
format: uuid
- in: query
name: continuationToken
description: A token for retrieving the next page of results.
required: false
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/TableShortcuts'
'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:
* InvalidItemType - Invalid item type'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
summary: Creates a new table shortcut under a database
description: 'This API supports long running operations (LRO).
## Permissions
The caller must have *read,write* permissions for the KQL database.
## Required Delegated Scopes
KQLDatabase.ReadWrite.All and OneLake.ReadWrite.All
or Item.ReadWrite.All and OneLake.ReadWrite.All
## 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:
- TableShortcuts
operationId: TableShortcuts_CreateShortcut
x-ms-fabric-sdk-long-running-operation: true
parameters:
- in: path
name: workspaceId
description: The ID of the workspace.
required: true
schema:
type: string
format: uuid
- in: path
name: kqlDatabaseId
description: The KQL database ID.
required: true
schema:
type: string
format: uuid
responses:
'202':
description: Request accepted. Table shortcut creation is in progress.
headers:
Location:
description: The URL of the operation status, which can be used to track the operation state.
schema:
type: string
Retry-After:
description: The number of seconds to wait before retrying the request.
schema:
type: integer
x-ms-operation-id:
description: The operation ID used with long running operations (LRO) APIs to track the operation state and get the result.
schema:
type: string
format: uuid
'201':
description: Successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/TableShortcut'
'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:
* FailureToReserveTableShortcutName - The KQL Database already has an entity with the shortcut name.
* Unauthorized - Caller is not authorized on the KQL database'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTableShortcutRequest'
description: An object representing the properties of the shortcut to create.
required: true
/workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}/shortcuts/{shortcutName}:
get:
summary: Returns the properties of a table shortcut under a database
description: '## Permissions
The caller must have *read* permissions for the KQL database.
## Required Delegated Scopes
All of the below scopes are required:
- KQLDatabase.Read.All or KQLDatabase.ReadWrite.All or Item.Read.All or Item.ReadWrite.All
- OneLake.Read.All or OneLake.ReadWrite.All
## 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:
- TableShortcuts
operationId: TableShortcuts_GetShortcut
parameters:
- in: path
name: workspaceId
description: The workspace ID.
required: true
schema:
type: string
format: uuid
- in: path
name: kqlDatabaseId
description: The KQL database ID.
required: true
schema:
type: string
format: uuid
- in: path
name: shortcutName
description: The name of the shortcut
required: true
schema:
type: string
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/TableShortcut'
'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:
* TableShortcutNotFound - The requested table shortcut was not found.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
summary: Deletes a table shortcut under a database
description: '## Permissions
The caller must have *read,write* permissions for the KQL database.
## Required Delegated Scopes
KQLDatabase.ReadWrite.All and OneLake.ReadWrite.All
or Item.ReadWrite.All and OneLake.ReadWrite.All
## 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:
- TableShortcuts
operationId: TableShortcuts_DeleteShortcut
parameters:
- in: path
name: workspaceId
description: The workspace ID.
required: true
schema:
type: string
format: uuid
- in: path
name: kqlDatabaseId
description: The KQL database ID.
required: true
schema:
type: string
format: uuid
- in: path
name: shortcutName
description: The name of the shortcut
required: true
schema:
type: string
responses:
'200':
description: Request completed 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:
* TableShortcutNotFound - The requested table shortcut was not found.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
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
AdlsGen2:
description: An object containing the properties of the target ADLS Gen2 data source.
type: object
required:
- location
- subpath
- connectionId
properties:
location:
description: Specifies the location of the target ADLS container. The URI must be in the format https://[account-name].dfs.core.windows.net where [account-name] is the name of the target ADLS account.
type: string
format: uri
subpath:
description: 'Specifies the container and subfolder within the ADLS account where the target folder is located. Must be of the format [container]/[subfolder] where [container] is the name of the container that holds the files and folders; [subfolder] is the name of the subfolder within the container (optional). For example: /mycontainer/mysubfolder'
type: string
connectionId:
description: A string representing the connection that is bound with the shortcut. The connectionId is a unique identifier used to establish a connection between the shortcut and the target datasource. To find this connection ID, first [create a cloud connection](/fabric/data-factory/data-source-management#add-a-data-source) to be used by the shortcut when connecting to the ADLS data location. Open the cloud connection's Settings view and copy the connection ID; this is a GUID.
type: string
format: uuid
OneLake:
description: An object containing the properties of the target OneLake data source.
type: object
required:
- itemId
- workspaceId
- path
properties:
itemId:
description: 'The ID of the target in OneLake. The target can be an item of Lakehouse, KQLDatabase, or Warehouse. '
type: string
format: uuid
workspaceId:
description: The ID of the target workspace.
type: string
format: uuid
path:
description: 'A string representing the full path to the target folder within the Item. This path should be relative to the root of the OneLake directory structure. For example: "Tables/myTablesFolder/someTableSubFolder".'
type: string
connectionId:
description: A string representing the connection that is bound with the shortcut. The connectionId is a unique identifier used to establish a connection between the shortcut and the target datasource. To find this connection ID, first [create a cloud connection](/fabric/data-factory/data-source-management#add-a-data-source) to be used by the shortcut when connecting to the Amazon S3 data location. Open the cloud connection's Settings view and copy the connection ID; this is a GUID.
type: string
format: uuid
AzureBlobStorage:
description: An object containing the properties of the target Azure Blob Storage data source.
type: object
required:
- location
- subpath
- connectionId
properties:
location:
description: Specifies the location of the target Azure Blob Storage container. The URI must be in the format `https://[account-name].blob.core.windows.net` where `[account-name]` is the name of the target Azure Blob Storage account.
type: string
format: uri
subpath:
description: 'Specifies the container and subfolder within the Azure Blob Storage account where the target folder is located. Must be of the format [container]/[subfolder]. [Container] is the name of the container that holds the files and folders. [Subfolder] is the name of the subfolder within the container and is optional. For example: /mycontainer/mysubfolder'
type: string
connectionId:
description: A string representing the connection that is bound with the shortcut. The connectionId is a unique identifier used to establish a connection between the shortcut and the target datasource. To find this connection ID, first [create a cloud connection](/fabric/data-factory/data-source-management#add-a-data-source) to be used by the shortcut when connecting to the Azure Blob Storage data location. Open the cloud connection's settings view and copy the GUID that is the connection ID.
type: string
format: uuid
AmazonS3:
description: An object containing the properties of the target Amazon S3 data source.
type: object
required:
- location
- connectionId
properties:
location:
description: 'HTTP URL that points to the target bucket in S3. The URL should be in the format https://[bucket-name].s3.[region-code].amazonaws.com, where "bucket-name" is the name of the S3 bucket you want to point to, and "region-code" is the code for the region where the bucket is located. For example: https://my-s3-bucket.s3.us-west-2.amazonaws.com'
type: string
format: uri
subpath:
description: Specifies a target folder or subfolder within the S3 bucket.
type: string
connectionId:
description: A string representing the connection that is bound with the shortcut. The connectionId is a unique identifier used to establish a connection between the shortcut and the target datasource. To find this connection ID, first [create a cloud connection](/fabric/data-factory/data-source-management#add-a-data-source) to be used by the shortcut when connecting to the Amazon S3 data location. Open the cloud connection's Settings view and copy the connection ID; this is a GUID.
type: string
format: uuid
TableShortcuts:
required:
- value
type: object
properties:
value:
description: A list of table shortcuts.
type: array
items:
$ref: '#/components/schemas/TableShortcut'
allOf:
- $ref: '#/components/schemas/PaginatedResponse'
ShortcutType:
description: Target type of the shortcut. String value representing one of the supported datasources. Additional `ShortcutType` types may be added over time.
type: string
enum:
- OneLake
- AmazonS3
- AdlsGen2
- GoogleCloudStorage
- S3Compatible
- AzureBlobStorage
x-ms-enum:
name: ShortcutType
modelAsString: true
values:
- value: OneLake
description: Specifies target properties for OneLake datasource.
- value: AmazonS3
description: Specifies target properties for Amazon S3 datasource.
- value: AdlsGen2
description: Specifies target properties for AdlsGen2 datasource.
- value: GoogleCloudStorage
description: Specifies target properties for GoogleCloudStorage datasource.
- value: S3Compatible
description: Specifies target properties for S3Compatible datasource.
- value: AzureBlobStorage
description: Specifies target properties for AzureBlobStorage datasource.
TableShortcut:
description: Properties of a table shortcut.
type: object
required:
- name
- enableQueryAcceleration
- target
properties:
name:
description: 'The table shortcut name. The table shortcut name cannot contain the following characters: ? : / \ " ] [ + # %'
type: string
readOnly: false
enableQueryAcceleration:
description: A boolean flag indicating whether the shortcut has query acceleration enabled.
type: boolean
readOnly: false
target:
$ref: '#/components/schemas/Target'
CreatableShortcutTarget:
description: An object that contains the target datasource, and must specify exactly one of the supported destinations as described in the table below.
type: object
properties:
oneLake:
$ref: '#/components/schemas/OneLake'
amazonS3:
$ref: '#/components/schemas/AmazonS3'
adlsGen2:
$ref: '#/components/schemas/AdlsGen2'
googleCloudStorage:
$ref: '#/components/schemas/GoogleCloudStorage'
s3Compatible:
$ref: '#/components/schemas/S3Compatible'
azureBlobStorage:
$ref: '#/components/schemas/AzureBlobStorage'
GoogleCloudStorage:
description: An object containing the properties of the target Google Cloud Storage data source.
type: object
required:
- location
- subpath
- connectionId
properties:
location:
description: 'HTTP URL that points to the target bucket in GCS. The URL should be in the format https://[bucket-name].storage.googleapis.com, where [bucket-name] is the name of the bucket you want to point to. For example: https://my-gcs-bucket.storage.googleapis.com'
type: string
format: uri
subpath:
description: 'Specifies a target folder or subfolder within the GCS bucket. For example: /folder'
type: string
connectionId:
description: A string representing the connection that is bound with the shortcut. The connectionId is a unique identifier used to establish a connection between the shortcut and the target datasource.
type: string
format: uuid
Target:
description: An object that contains the target datasource, and must specify exactly one of the supported destinations as described in the table below.
type: object
properties:
type:
$ref: '#/components/schemas/ShortcutType'
oneLake:
$ref: '#/components/schemas/OneLake'
amazonS3:
$ref: '#/components/schemas/AmazonS3'
adlsGen2:
$ref: '#/components/schemas/AdlsGen2'
googleCloudStorage:
$ref: '#/components/schemas/GoogleCloudStorage'
s3Compatible:
$ref: '#/components/schemas/S3Compatible'
azureBlobStorage:
$ref: '#/components/schemas/AzureBlobStorage'
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
CreateTableShortcutRequest:
description: Properties of a request to create a new table shortcut
type: object
required:
- name
- enableQueryAcceleration
- target
properties:
name:
description: 'The table shortcut name. The table shortcut name cannot contain the following characters: ? : / \ " ] [ + # %'
type: string
readOnly: false
enableQueryAcceleration:
description: A boolean flag indicating whether the shortcut has query acceleration enabled.
type: boolean
readOnly: false
target:
$ref: '#/components/schemas/CreatableShortcutTarget'
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.
S3Compatible:
description: An object containing the properties of the target S3 compatible data source.
type: object
required:
- location
- subpath
- bucket
- connectionId
properties:
location:
description: 'HTTP URL of the S3 compatible endpoint. This endpoint must be able to receive ListBuckets S3 API calls. The URL must be in the non-bucket specific format; no bucket should be specified here. For example: https://s3endpoint.contoso.com'
type: string
format: uri
subpath:
description: 'Specifies a target folder or subfolder within the S3 compatible bucket. For example: /folder'
type: string
bucket:
description: Specifies the target bucket within the S3 compatible location.
type: string
connectionId:
description: A string representing the connection that is bound with the shortcut. The connectionId is a unique identifier used to establish a connection between the shortcut and the target datasource.
type: string
format: uuid
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