Microsoft Fabric Restore Points API

The RestorePoints API from Microsoft Fabric — 3 operation(s) for restorepoints.

Operations 6

GET /workspaces/{workspaceId}/warehouses/{warehouseId}/restorePoints Returns all restore points for a warehouse #
POST /workspaces/{workspaceId}/warehouses/{warehouseId}/restorePoints Creates a restore point for a warehouse at the current timestamp #
GET /workspaces/{workspaceId}/warehouses/{warehouseId}/restorePoints/{restorePointId} Returns the properties of a restore point specified for a warehouse #
DELETE /workspaces/{workspaceId}/warehouses/{warehouseId}/restorePoints/{restorePointId} Deletes a restore point specified for a warehouse #
PATCH /workspaces/{workspaceId}/warehouses/{warehouseId}/restorePoints/{restorePointId} Updates an existing restore point by renaming the name or description of it #
POST /workspaces/{workspaceId}/warehouses/{warehouseId}/restorePoints/{restorePointId}/restore Restores a warehouse in-place to the restore point specified #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-fabric:microsoft-fabric-restorepoints-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

microsoft-fabric-restorepoints-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Microsoft Fabric Workload Items REST Restore Points 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: RestorePoints
paths:
  /workspaces/{workspaceId}/warehouses/{warehouseId}/restorePoints:
    get:
      summary: Returns all restore points for a warehouse
      description: 'This API supports pagination.


        ## Permissions


        The caller must have *read* or *write* warehouse permission.


        ## Required Delegated Scopes


        Warehouse.Read.All or Warehouse.ReadWrite.All or 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:
      - RestorePoints
      operationId: RestorePoints_ListRestorePoints
      x-ms-pageable:
        nextLinkName: continuationUri
      parameters:
      - in: path
        name: workspaceId
        description: The workspace ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: warehouseId
        description: The warehouse 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/RestorePoints'
        '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 restore point for a warehouse at the current timestamp
      description: 'This API supports long running operations (LRO).


        ## Permissions


        The caller must have *write* warehouse permission.


        ## Required Delegated Scopes


        Warehouse.ReadWrite.All or Item.ReadWrite.All


        ## Limitations


        Warehouse deletes both the system-created and user-defined restore point at the expiry of the 30 calendar day retention period.


        A restore point cannot be created if there is already a restore point creation already in-progress or during warehouse creation, deletion or rename.


        ## 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:
      - RestorePoints
      operationId: RestorePoints_CreateRestorePoint
      x-ms-fabric-sdk-long-running-operation: true
      parameters:
      - in: path
        name: workspaceId
        description: The workspace ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: warehouseId
        description: The warehouse ID.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '201':
          description: Successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestorePoint'
        '202':
          description: Request accepted, restore point creation in progress.
          headers:
            Location:
              description: The URL of the operation status, which can be used to track the operation state.
              schema:
                type: string
            x-ms-operation-id:
              description: The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.
              schema:
                type: string
                format: uuid
            Retry-After:
              description: The number of seconds to wait before retrying the request.
              schema:
                type: integer
        '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:


            * RestorePointCreationAlreadyInProgress - A restore point creation is already in-progress.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRestorePointRequest'
        description: Create restore point payload.
        required: true
  /workspaces/{workspaceId}/warehouses/{warehouseId}/restorePoints/{restorePointId}:
    get:
      summary: Returns the properties of a restore point specified for a warehouse
      description: '## Permissions


        The caller must have *read* or *write* warehouse permission.


        ## Required Delegated Scopes


        Warehouse.Read.All or Warehouse.ReadWrite.All or 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:
      - RestorePoints
      operationId: RestorePoints_GetRestorePoint
      parameters:
      - in: path
        name: workspaceId
        description: The workspace ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: warehouseId
        description: The warehouse ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: restorePointId
        description: The restore point ID.
        required: true
        schema:
          type: string
          format: string
      responses:
        '200':
          description: Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestorePoint'
        '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:


            * RestorePointNotFound - The requested restore point does not exist, or the caller doesn''t have sufficient permissions for this operation.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      summary: Deletes a restore point specified for a warehouse
      description: '## Permissions


        The caller must have *write* warehouse permission.


        ## Required Delegated Scopes


        Warehouse.ReadWrite.All or Item.ReadWrite.Alll


        ## Limitations


        You can delete user-defined restore points, but system-created restore points cannot be deleted.


        ## 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:
      - RestorePoints
      operationId: RestorePoints_DeleteRestorePoint
      parameters:
      - in: path
        name: workspaceId
        description: The workspace ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: warehouseId
        description: The warehouse ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: restorePointId
        description: The restore point ID.
        required: true
        schema:
          type: string
          format: 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:\n\n* RestorePointNotFound - The requested restore point does not exist, or the caller doesn't have sufficient permissions for this operation. \n\n* CannotDeleteAutomaticRestorePointException - System generated restore points cannot be deleted."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    patch:
      summary: Updates an existing restore point by renaming the name or description of it
      description: '## Permissions


        The caller must have *write* warehouse permission.


        ## Required Delegated Scopes


        Warehouse.ReadWrite.All or Item.ReadWrite.Alll


        ## 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:
      - RestorePoints
      operationId: RestorePoints_UpdateRestorePoint
      parameters:
      - in: path
        name: workspaceId
        description: The workspace ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: warehouseId
        description: The warehouse ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: restorePointId
        description: The restore point ID.
        required: true
        schema:
          type: string
          format: string
      responses:
        '200':
          description: Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RestorePoint'
        '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* RestorePointNotFound - The requested restore point does not exist, or the caller doesn't have sufficient permissions for this operation. \n\n* InvalidRequest - Invalid update request."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRestorePointRequest'
        description: Update restore point payload.
        required: true
  /workspaces/{workspaceId}/warehouses/{warehouseId}/restorePoints/{restorePointId}/restore:
    post:
      summary: Restores a warehouse in-place to the restore point specified
      description: 'This API supports long running operations (LRO).


        ## Permissions


        The caller must have *restore* warehouse permission.


        ## Required Delegated Scopes


        Warehouse.Restore.All


        ## Limitations


        A restore point cannot be restored if there is another restore point restoration already in-progress.


        ## 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:
      - RestorePoints
      operationId: RestorePoints_RestoreToRestorePoint
      x-ms-fabric-sdk-long-running-operation: true
      parameters:
      - in: path
        name: workspaceId
        description: The workspace ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: warehouseId
        description: The warehouse ID.
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: restorePointId
        description: The restore point ID.
        required: true
        schema:
          type: string
          format: string
      responses:
        '200':
          description: Request completed successfully.
        '202':
          description: Request accepted, restore point restoration in progress.
          headers:
            Location:
              description: The URL of the operation status, which can be used to track the operation state.
              schema:
                type: string
            x-ms-operation-id:
              description: The operation ID which can be used with long running operations (LRO) APIs to track the operation state and get the result.
              schema:
                type: string
                format: uuid
            Retry-After:
              description: The number of seconds to wait before retrying the request.
              schema:
                type: integer
        '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* RestorePointNotFound - The requested restore point does not exist, or the caller doesn't have sufficient permissions for this operation. \n\n* RestorePointRestorationAlreadyInProgress - A restore point restoration is already in-progress."
          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
    CreateRestorePointRequest:
      description: Create restore point request payload.
      properties:
        displayName:
          description: The restore point name. Maximum length is 128 characters.
          type: string
          readOnly: false
        description:
          description: The restore point description. Maximum length is 512 characters.
          type: string
          readOnly: false
    PrincipalType:
      description: The type of the principal. Additional principal types may be added over time.
      type: string
      enum:
      - User
      - ServicePrincipal
      - Group
      - ServicePrincipalProfile
      - EntireTenant
      x-ms-enum:
        name: PrincipalType
        modelAsString: true
        values:
        - value: User
          description: Principal is a Microsoft Entra user principal.
        - value: ServicePrincipal
          description: Principal is a Microsoft Entra service principal.
        - value: Group
          description: Principal is a security group.
        - value: ServicePrincipalProfile
          description: Principal is a service principal profile.
        - value: EntireTenant
          description: Principal represents all tenant users.
    RestorePoint:
      type: object
      description: The properties of a restore point.
      required:
      - id
      - displayName
      - description
      - creationMode
      - creationDetails
      properties:
        id:
          description: The restore point ID.
          type: string
          readOnly: true
        displayName:
          description: The restore point name.
          type: string
          readOnly: false
        description:
          description: The restore point description.
          type: string
          readOnly: false
        creationMode:
          description: The creation mode of the restore point. Additional creation mode types may be added over time.
          type: string
          readOnly: true
          enum:
          - UserDefined
          - SystemCreated
          x-ms-enum:
            name: CreationModeType
            modelAsString: true
            values:
            - value: UserDefined
              description: User defined restore point.
            - value: SystemCreated
              description: System created restore point.
        creationDetails:
          $ref: '#/components/schemas/RestorePointEventDetails'
    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
    UpdateRestorePointRequest:
      description: Update restore point request payload.
      properties:
        displayName:
          description: The restore point name. Maximum length is 128 characters.
          type: string
          readOnly: false
        description:
          description: The restore point description. Maximum length is 512 characters.
          type: string
          readOnly: false
    Principal:
      description: Represents an identity or a Microsoft Entra group.
      type: object
      required:
      - id
      - type
      discriminator:
        propertyName: type
      properties:
        id:
          description: The principal's ID.
          type: string
          format: uuid
          readOnly: false
        displayName:
          description: The principal's display name.
          type: string
          readOnly: true
        type:
          $ref: '#/components/schemas/PrincipalType'
    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.
    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
    RestorePoints:
      description: A list of restore points.
      required:
      - value
      type: object
      properties:
        value:
          description: A list of restore points.
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/RestorePoint'
      allOf:
      - $ref: '#/components/schemas/PaginatedResponse'
    RestorePointEventDetails:
      type: object
      description: The restore point event details.
      required:
      - eventDateTime
      properties:
        eventDateTime:
          description: The time of the restore point event in UTC, using the YYYY-MM-DDTHH:mm:ssZ format.
          type: string
          format: date-time
          readOnly: true
        eventInitiator:
          $ref: '#/components/schemas/Principal'