---
name: fabric-rest-api-remediate-e348408c7406
description: Diagnose and resolve Microsoft Fabric REST API errors including HTTP 401 Unauthorized, 403 Forbidden, 404 Not Found, 429 Throttling, and 5xx server errors. Use when debugging Fabric API authentication failures, Entra ID token issues, insufficient scopes, throttling/rate limiting, long running operation (LRO) polling failures, pagination problems, service principal configuration, or capacity API errors. Covers PowerShell and C# remediate workflows against api.fabric.microsoft.com.
license: Complete terms in LICENSE.txt
---

# Microsoft Fabric REST API remediate

Structured diagnostic workflows for identifying and resolving errors when calling Microsoft Fabric REST APIs (`https://api.fabric.microsoft.com/v1/`).

## When to Use This Skill

- Fabric REST API returns an HTTP error (401, 403, 404, 429, 5xx)
- Authentication or token acquisition fails with MSAL
- Service principal or managed identity calls are rejected
- API calls are being throttled (HTTP 429)
- Long running operations (LRO) fail or time out during polling
- Pagination with `continuationToken` stops working or returns incomplete results
- Capacity API operations fail (create, update, resume, suspend)
- Need to implement retry logic with exponential backoff for Fabric APIs
- Debugging `errorCode` values in Fabric API error responses

## Prerequisites

- Microsoft Entra ID app registration with appropriate Fabric API permissions
- PowerShell 7+ with `Az.Accounts` module or MSAL.PS for token acquisition
- Access to a Microsoft Fabric workspace (Contributor or higher)
- Tenant setting **Service principals can use Fabric APIs** enabled (if using service principals)

## Quick Diagnostic: Identify Your Error

Start here. Match your HTTP status code to the appropriate workflow.

| HTTP Status | Error Category | Jump To |
|-------------|---------------|---------|
| 401 | Authentication / Token | [Authentication Failures](#workflow-1-authentication-failures-401) |
| 403 | Permissions / Authorization | [Permission Denied](#workflow-2-permission-denied-403) |
| 404 | Resource Not Found | [Resource Not Found](#workflow-3-resource-not-found-404) |
| 429 | Throttling / Rate Limit | [Throttling](#workflow-4-throttling-429) |
| 430 | Spark Compute Limit | [Capacity Limits](#workflow-5-capacity-and-spark-limits-430) |
| 500/502/503 | Server Error | [Server Errors](#workflow-6-server-errors-5xx) |
| 202 then failure | LRO Polling Issue | [LRO remediate](#workflow-7-long-running-operation-failures) |

## Understanding Fabric Error Responses

Every Fabric API error returns an `ErrorResponse` object. Always capture the `requestId` for support escalation.

```json
{
  "errorCode": "TokenExpired",
  "message": "The access token has expired.",
  "moreDetails": [],
  "relatedResource": {
    "resourceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "resourceType": "workspace"
  },
  "requestId": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
}
```

Key rules for error handling:
1. Parse `errorCode` for programmatic logic (stable, contract-based)
2. Never parse `message` programmatically (may change over time)
3. Always log `requestId` for support cases
4. Check `relatedResource` to identify which resource caused the error

---

## Workflow 1: Authentication Failures (401)

A 401 means the request failed during authentication or access token validation.

**Step 1 — Check the `errorCode` in the response body**

| errorCode | Root Cause | Fix |
|-----------|-----------|-----|
| `TokenExpired` | Access token has expired | Acquire a fresh token and retry |
| `InsufficientScopes` | Token missing required scopes | Request correct scopes in MSAL call |

**Step 2 — Validate your token**

Run the [diagnostic script](./scripts/Test-FabricApiConnection.ps1) to test connectivity:

```powershell
./scripts/Test-FabricApiConnection.ps1 -TestEndpoint "workspaces"
```

Or decode and inspect your token manually:

```powershell
# Decode JWT token payload (PowerShell)
$token = "<your-access-token>"
$payload = $token.Split('.')[1]
$padding = 4 - ($payload.Length % 4)
if ($padding -lt 4) { $payload += '=' * $padding }
$decoded = [System.Text.Encoding]::UTF8.GetString(
    [System.Convert]::FromBase64String($payload)
) | ConvertFrom-Json
# Check expiration
$expiry = [DateTimeOffset]::FromUnixTimeSeconds($decoded.exp).LocalDateTime
Write-Host "Token expires: $expiry"
Write-Host "Scopes (scp): $($decoded.scp)"
Write-Host "Audience (aud): $($decoded.aud)"
```

**Step 3 — Verify scopes match the API**

Fabric REST APIs use scopes in the format `https://api.fabric.microsoft.com/<Scope>`. Common scopes:

| Scope | Purpose |
|-------|---------|
| `Workspace.ReadWrite.All` | Full workspace CRUD |
| `Item.ReadWrite.All` | Full item CRUD |
| `Item.Read.All` | Read-only item access |
| `Item.Execute.All` | Execute items (notebooks, pipelines) |
| `<ItemType>.ReadWrite.All` | Item-specific CRUD (e.g., `Notebook.ReadWrite.All`) |

**Step 4 — If using service principal or managed identity**

Confirm the **Service principals can use Fabric APIs** tenant setting is enabled. Not all APIs support service principals — check the individual API reference page for identity support.

See [authentication-guide.md](./references/authentication-guide.md) for detailed token acquisition examples in PowerShell and C#.

---

## Workflow 2: Permission Denied (403)

A 403 means the caller is authenticated but lacks permissions on the target resource.

**Step 1 — Check the `errorCode`**

| errorCode | Root Cause | Fix |
|-----------|-----------|-----|
| `InsufficientPrivileges` | Missing workspace/item permissions | Request access from workspace admin |

**Step 2 — Verify workspace role**

The calling identity needs at least **Contributor** role for write operations and **Viewer** for read operations.

**Step 3 — Check for API-specific requirements**

Some APIs require Fabric Admin permissions. Admin APIs are under `/v1/admin/` paths. Confirm the calling identity has the Fabric Administrator role if targeting admin endpoints.

**Step 4 — Service principal considerations**

If the API call relies on downstream items that don't support service principals, the call fails even if the top-level API does. For example, calling `Items - Create Item` to create a data warehouse will fail because data warehouses don't support service principal identity.

---

## Workflow 3: Resource Not Found (404)

A 404 means the specified resource doesn't exist or isn't accessible to the caller.

**Step 1 — Check the `errorCode`**

| errorCode | Root Cause | Fix |
|-----------|-----------|-----|
| `WorkspaceNotFound` | Invalid workspace ID | Verify the workspace GUID |
| `EntityNotFound` | Invalid resource ID | Check `relatedResource` in error for details |

**Step 2 — Validate your IDs**

```powershell
# List all accessible workspaces to find correct ID
$headers = @{ Authorization = "Bearer $token" }
$response = Invoke-RestMethod -Uri "https://api.fabric.microsoft.com/v1/workspaces" `
    -Headers $headers
$response.value | Select-Object id, displayName | Format-Table
```

**Step 3 — Check URL construction**

Fabric API base: `https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items`

Common mistakes: mixing up `workspaceId` with `itemId`, using display names instead of GUIDs, or targeting the wrong API version.

---

## Workflow 4: Throttling (429)

A 429 means rate limits have been exceeded. Fabric throttles per caller identity per API within one-minute windows.

**Step 1 — Read the `Retry-After` header**

The response includes a `Retry-After` header indicating seconds to wait. Always use this value rather than hardcoded delays.

**Step 2 — Implement bounded retry with exponential backoff**

Use the [retry helper script](./scripts/Invoke-FabricApiWithRetry.ps1):

```powershell
./scripts/Invoke-FabricApiWithRetry.ps1 `
    -Uri "https://api.fabric.microsoft.com/v1/workspaces" `
    -Token $token `
    -MaxRetries 5
```

**Step 3 — Reduce throttling likelihood**

| Strategy | How |
|----------|-----|
| Use batch/bulk operations | Prefer `List Items` over individual `Get Item` calls |
| Cache metadata | Store workspace/item IDs locally, refresh periodically |
| Spread requests | Add jitter between calls; avoid burst patterns |
| Use pagination efficiently | Follow `continuationToken` to completion in a single pass |

See [error-codes-reference.md](./references/error-codes-reference.md) for the complete error code table.

---

## Workflow 5: Capacity and Spark Limits (430)

HTTP 430 is Fabric-specific for Spark compute limits.

**Error message**: `[TooManyRequestsForCapacity] This spark job can't be run because you have hit a spark compute or API rate limit.`

**Resolution options**:
1. Cancel an active Spark job via the Monitoring Hub
2. Upgrade to a larger capacity SKU (queue limits scale with SKU size)
3. Wait and retry later

| Fabric SKU | Queue Limit |
|------------|-------------|
| F2 | 4 |
| F8 | 8 |
| F64 / P1 | 64 |
| F128 / P2 | 128 |
| F256 / P3 | 256 |
| Trial | No queueing |

---

## Workflow 6: Server Errors (5xx)

**Step 1 — Capture the `requestId`** from the response body or header. This is essential for Microsoft Support escalation.

**Step 2 — Retry with backoff**. Transient 500/502/503 errors often resolve on retry.

**Step 3 — Check Fabric service health** at [Microsoft 365 Service Health](https://admin.microsoft.com/Adminportal/Home#/servicehealth) or [Azure Status](https://status.azure.com/).

**Step 4 — If persistent**, open a support ticket including the `requestId`, timestamp, and full request/response details.

---

## Workflow 7: Long Running Operation Failures

Fabric uses LRO (Long Running Operations) for time-consuming tasks. An LRO returns HTTP 202 with polling headers.

**Step 1 — Capture response headers after 202**

| Header | Purpose |
|--------|---------|
| `Location` | URL to poll for operation status |
| `x-ms-operation-id` | Operation ID for constructing status URL |
| `Retry-After` | Seconds to wait before first poll |

**Step 2 — Poll the operation status**

Two approaches:
1. Use the `Location` header URL directly (preferred)
2. Construct: `GET https://api.fabric.microsoft.com/v1/operations/{operationId}`

**Step 3 — Handle terminal states**

| Status | Meaning | Action |
|--------|---------|--------|
| `Running` | Still in progress | Continue polling |
| `Succeeded` | Completed successfully | Fetch result if available |
| `Failed` | Operation failed | Check error details in response |

**Step 4 — Get the result**

If the operation has a result, append `/result` to the operation URL:
`GET https://api.fabric.microsoft.com/v1/operations/{operationId}/result`

See [long-running-operations.md](./references/long-running-operations.md) for complete polling implementation patterns.

---

## Workflow 8: Pagination Issues

Fabric uses `continuationToken` / `continuationUri` for paginated responses.

**Step 1 — Follow the token to completion**

```powershell
$allItems = @()
$uri = "https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items"
do {
    $response = Invoke-RestMethod -Uri $uri -Headers $headers
    $allItems += $response.value
    $uri = $response.continuationUri
} while ($uri)
```

**Step 2 — Common pitfalls**

| Problem | Cause | Fix |
|---------|-------|-----|
| Missing items | Stopped before token was null | Loop until `continuationToken` is null or absent |
| URL encoding errors | Token not URL-encoded | Use `continuationUri` directly (pre-encoded) |
| Stale token | Token expired mid-pagination | Refresh the bearer token between pages |

---

## remediate Decision Tree

```
API call fails
├── Got HTTP response?
│   ├── 401 → Check token expiry and scopes
│   ├── 403 → Check workspace role and API identity support
│   ├── 404 → Verify workspace/item GUIDs
│   ├── 429 → Honor Retry-After, implement backoff
│   ├── 430 → Spark capacity limit, scale up or wait
│   ├── 5xx → Retry with backoff, check service health
│   └── 202 → LRO started, poll Location header
├── Network error / timeout?
│   ├── Check DNS resolution for api.fabric.microsoft.com
│   ├── Verify no proxy/firewall blocking HTTPS
│   └── Test with: Invoke-RestMethod -Uri "https://api.fabric.microsoft.com/v1/"
└── Token acquisition failed?
    ├── Check Entra app registration exists
    ├── Verify redirect URI matches
    ├── Confirm API permissions granted and admin-consented
    └── See authentication-guide.md
```

## References

- [Error Codes Reference](./references/error-codes-reference.md) — Complete Fabric API error code table
- [Authentication Guide](./references/authentication-guide.md) — Token acquisition patterns for PowerShell and C#
- [Long Running Operations](./references/long-running-operations.md) — LRO polling implementation patterns
- [Test-FabricApiConnection.ps1](./scripts/Test-FabricApiConnection.ps1) — Diagnostic connectivity test
- [Invoke-FabricApiWithRetry.ps1](./scripts/Invoke-FabricApiWithRetry.ps1) — Retry logic with exponential backoff
- [Fabric-Api-ErrorHandler.template.ps1](./templates/Fabric-Api-ErrorHandler.template.ps1) — Starter error handling scaffold


---
Source attribution: PatrickGallucci
Original project: https://github.com/PatrickGallucci/fabric-skills
License: Apache-2.0
License information: https://www.apache.org/licenses/LICENSE-2.0
Original upstream instructions; downloaded from Mega AI Hub.

## Upstream license notice


                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright [yyyy] [name of copyright owner]

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.



# Mega AI Hub resource metadata

Creator / publisher: PatrickGallucci
Original project: https://github.com/PatrickGallucci/fabric-skills
Attribution basis: Upstream repository explicitly recorded in package mirror path

Fields of work: Development & Engineering, Product Management
Roles: Backend Developer, Data Engineer, DevOps / SRE, ML / AI Engineer, Technical Product Manager
Specialties: API, Backend
Tools: Powershell, Microsoft Fabric
Country applicability: Country not specified
Classification basis: Source catalog labels
Instruction SHA-256: afccecf7ea9436811643aeb69be6787b994757d032d45926cd96b1624034363a
