Refresh - Refresh Catalog Metadata

Service:: MirroredCatalog

API Version:: v1

Triggers a refresh of catalog metadata from the source.
This API supports long running operations (LRO).

Refreshes the catalog metadata from the source Iceberg REST Catalog, synchronizing namespace and table changes.

Permissions

The caller must have read and write permissions for the mirrored catalog.

Required Delegated Scopes

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

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/mirroredCatalogs/{mirroredCatalogId}/refreshCatalogMetadata

URI Parameters

Name	In	Required	Type	Description
mirroredCatalogId	path	True	string (uuid)	The MirroredCatalog ID.
workspaceId	path	True	string (uuid)	The workspace ID.

Responses

Name	Type	Description
200 OK		Request completed successfully.
202 Accepted		Request accepted. Catalog metadata refresh is in progress. Headers Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	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. Headers Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: ItemNotFound - The requested item was not found.

Examples

Refresh Catalog Metadata example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/mirroredCatalogs/5b218778-e7a5-4d73-8187-f10824047715/refreshCatalogMetadata

Sample response

Status code:: 200

Status code:: 202

Location: https://api.fabric.microsoft.com/v1/operations/8f29c846-7dc2-4b21-9c2d-0a1b5e3c6d7f
x-ms-operation-id: 8f29c846-7dc2-4b21-9c2d-0a1b5e3c6d7f
Retry-After: 30

Definitions

Name	Description
ErrorParameter	A structured parameter providing additional machine-readable context about an error.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.

ErrorParameter

Object

A structured parameter providing additional machine-readable context about an error.

Name	Type	Description
message	string	A human-readable description of the parameter's meaning.
name	string	The parameter identifier.
value	string	The parameter value.

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.
isRetriable	boolean	When true, the request can be retried. Use the `Retry-After` response header to determine the delay, if available.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
parameters	ErrorParameter[]	Structured parameters providing additional machine-readable context about the error.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string (uuid)	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.
parameters	ErrorParameter[]	Structured parameters providing additional machine-readable context about the error.
relatedResource	ErrorRelatedResource	The error related resource details.