Microsoft Fabric Monitoring API
The Monitoring API from Microsoft Fabric — 2 operation(s) for monitoring.
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-monitoring-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 Monitoring 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: Monitoring
paths:
/workspaces/{workspaceId}/mirroredCatalogs/{mirroredCatalogId}/mirroringStatus?beta=true:
get:
summary: Returns the overall mirroring status of the MirroredCatalog
description: '> [!NOTE]
> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.
**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**
Returns the overall mirroring status of the MirroredCatalog.
## Permissions
The caller must have *read* permissions for the mirrored catalog.
## Required Delegated Scopes
Item.Read.All or Item.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:
- Monitoring
operationId: Monitoring_Mirroring_Status_(beta)
parameters:
- in: path
name: workspaceId
description: The workspace ID.
required: true
schema:
type: string
format: uuid
- in: path
name: mirroredCatalogId
description: The MirroredCatalog ID.
required: true
schema:
type: string
format: uuid
- in: query
name: beta
description: This required parameter must be set to `true` to access this API, which is currently in beta.
required: true
schema:
type: boolean
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/MirroringStatusResponse'
'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:
* ItemNotFound - The requested item was not found.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/workspaces/{workspaceId}/mirroredCatalogs/{mirroredCatalogId}/tablesMirroringStatus?beta=true:
get:
summary: Returns the per-table mirroring status for the MirroredCatalog
description: '> [!NOTE]
> This API is part of a Beta release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use.
**When calling this API, callers must specify `true` as the value for the query parameter `beta`.**
This API supports pagination.
Returns the per-table mirroring status for the MirroredCatalog. This API shows the mirroring status of each table in the source catalog.
## Permissions
The caller must have *read* permissions for the mirrored catalog.
## Required Delegated Scopes
Item.Read.All or Item.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:
- Monitoring
operationId: Monitoring_Tables_Mirroring_Status_(beta)
x-ms-pageable:
nextLinkName: continuationUri
parameters:
- in: path
name: workspaceId
description: The workspace ID.
required: true
schema:
type: string
format: uuid
- in: path
name: mirroredCatalogId
description: The MirroredCatalog ID.
required: true
schema:
type: string
format: uuid
- in: query
name: beta
description: This required parameter must be set to `true` to access this API, which is currently in beta.
required: true
schema:
type: boolean
- 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/TablesMirroringStatusResponse'
'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:
* ItemNotFound - The requested item 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
TablesMirroringStatusResponse:
description: Response containing the per-table mirroring status for the mirrored catalog.
required:
- value
type: object
properties:
value:
description: A list of per-table mirroring statuses.
type: array
items:
$ref: '#/components/schemas/TableMirroringStatus'
readOnly: true
allOf:
- $ref: '#/components/schemas/PaginatedResponse'
TableMirroringStatus:
description: The mirroring status for a single table.
type: object
required:
- schemaName
- name
- status
properties:
schemaName:
description: The schema (leaf namespace) name where the table resides.
type: string
readOnly: true
name:
description: The table name.
type: string
readOnly: true
status:
$ref: '#/components/schemas/TableMirroringState'
lastSyncDateTime:
description: Last sync attempt timestamp for this table. Null if the table was discovered but has not completed its first sync cycle yet. The timestamp is in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
type: string
format: date-time
readOnly: true
lastUpdateDateTime:
description: Last successful shortcut creation or update timestamp for this table. Null if the shortcut has never been successfully created. The timestamp is in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
type: string
format: date-time
readOnly: true
error:
$ref: '#/components/schemas/ErrorResponse'
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
TableMirroringState:
type: string
description: The table mirroring state. Additional `TableMirroringState` types may be added over time.
enum:
- Running
- Failed
- Stopped
x-ms-enum:
name: TableMirroringState
modelAsString: true
values:
- value: Running
description: Table is actively being mirrored and ready for use.
- value: Failed
description: Table mirroring failed. Check the `error` field for details.
- value: Stopped
description: Table is not being mirrored.
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.
MirroringStatusResponse:
description: Response containing the overall mirroring status of the mirrored catalog.
type: object
required:
- status
properties:
status:
$ref: '#/components/schemas/ItemMirroringState'
lastSyncDateTime:
description: Last sync attempt timestamp. Null if no sync has been attempted yet. The timestamp is in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
type: string
format: date-time
readOnly: true
error:
$ref: '#/components/schemas/ErrorResponse'
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
ItemMirroringState:
type: string
description: The mirroring state of the catalog. Additional `ItemMirroringState` types may be added over time.
enum:
- Running
- Stopped
- Failed
x-ms-enum:
name: ItemMirroringState
modelAsString: true
values:
- value: Running
description: Catalog mirroring is running.
- value: Stopped
description: Catalog mirroring has stopped.
- value: Failed
description: Catalog mirroring failed. Check the `error` field for details.