Which official API should I use to get the schedule of Pipelines and Notebooks in Microsoft Fabric a

[liney_marcela]

Hello community,

I am designing a monitoring solution in Microsoft Fabric to supervise the execution schedules of Pipelines and Notebooks. The goal is to identify their scheduled end date and automatically send alerts when there are certain remaining periods (for example, 1, 2, or 3 months) so that the schedule can be renewed or extended on time.

I already have a configuration table that maps the workspaces where there are scheduled artifacts, and a pipeline that dynamically iterates through these workspaces. The missing piece is how to automatically identify Pipelines and Notebooks with an active schedule, retrieve their start and end configuration through an official REST API, and automate the check.

I would like to clarify the following:
1. Which official REST API should be used to obtain information about Pipelines and Notebooks in Microsoft Fabric, specifically their execution schedule configuration?
2. What is the correct base URL and route to access this information through REST requests?
3. Which API permissions must be assigned to the Azure AD registered application to authenticate and access these endpoints correctly?
4. If there is currently no public or stable endpoint for this purpose, what is the recommended practice to monitor these schedules centrally and avoid the risk of the programmed execution expiring unnoticed?

I would appreciate any official documentation, recommended approaches, or real implementation examples that help me integrate this schedule validation and alert generation reliably.

Thank you in advance for your help.

Liney B.

[v-pnaroju-msft]

Hi liney_marcela,

We just wanted to check if the information we gave was helpful in solving your problem. If you need more help, please feel free to ask in the Microsoft Fabric community.

Thank you.

[v-pnaroju-msft]

Hi liney_marcela,

We wanted to check in and see if the information we provided has helped resolve your issue. If you need any further support, please don't hesitate to reach out to the Microsoft Fabric community.

Thank you.

[v-pnaroju-msft · Accepted solution]

Hi liney_marcela,

Thankyou for the follow up.

Please find below the steps which may assist in resolving the issue:

1. The permissions such as Item.Read.All, Notebook.Read.All, and Pipeline.Read.All are scopes related to the Microsoft Fabric REST API. Hence, these do not appear in the "API permissions" section of the Azure portal. Instead, these scopes are applied during the token request using the .default scope for Fabric.

2. Kindly register your Azure AD application and generate a client secret under Certificates & Secrets. Acquire an access token with the Fabric scope and use this OAuth scope in your token request as follows: scope=https://api.fabric.microsoft.com/.default. In the Microsoft Fabric Admin portal, please enable the option “Allow service principals to use Fabric APIs” and add the application to the required workspaces with Viewer or Contributor roles.

With this configuration, the application can securely access the Fabric REST API, including endpoints for Items, Pipelines, Notebooks, and Schedules.

Furthermore, please refer to the following links for additional guidance:
Microsoft Fabric REST APIs scopes - Microsoft Fabric REST APIs | Microsoft Learn
Enable service principal authentication for admin APIs - Microsoft Fabric | Microsoft Learn
Identity support for logging into the Microsoft Fabric - Microsoft Fabric REST APIs | Microsoft Lear...
REST API capabilities for Fabric Data Factory - Microsoft Fabric | Microsoft Learn

We hope the above information will assist in resolving the issue. Should you have any further queries, please feel free to reach out to the Microsoft Fabric community.

Thank you.

[v-pnaroju-msft]

Hi liney_marcela,

Thank you for your followup.

The reference to the required permissions as Microsoft Graph API scopes in the previous message was an oversight on my part, and I sincerely apologise for any confusion this may have caused.

The correct scopes Item.Read.All, Pipeline.Read.All (if using pipelines), and Notebook.Read.All (if using notebooks) are part of the Microsoft Fabric REST API, not Microsoft Graph. These scopes are specifically designed to secure access to Fabric artifacts through the Fabric REST API surface.

We hope this information will help resolve the issue. Should you have any further queries, please feel free to reach out to the Microsoft Fabric community.

Thank you.

[liney_marcela]

Hi v-pnaroju-msft,

Thank you for the guidance. I’ve reviewed the registered app in Azure AD intended to use the Microsoft Fabric REST API and assign the permissions Item.Read.All, Pipeline.Read.All, and Notebook.Read.All. However, these permissions do not appear in the API permissions section of the Azure portal.

Could you please confirm the following?

1. Is it possible to enable the Microsoft Fabric REST API on a registered app in Azure AD and assign these permissions directly?
2. If it is not possible to enable these permissions from Azure AD, is there any other service or recommended approach that allows access to these resources (Item, Pipeline, Notebook) or equivalent permissions?

I would appreciate any additional guidance on how to properly authenticate and consume these APIs from a registered application.

[v-pnaroju-msft]

Hi liney_marcela,

We would like to follow up and see whether the details we shared have resolved your problem.
If you need any more assistance, please feel free to connect with the Microsoft Fabric community.

Thank you.

[v-pnaroju-msft]

Hi liney_marcela,

We sincerely appreciate your query submitted through the Microsoft Fabric Community Forum.

Please find below the responses, which may assist you in resolving the issue:

1. The Microsoft Fabric Job Scheduler REST API can be used to retrieve the schedules of Pipelines and Notebooks. For Pipelines, use the endpoint with jobType=Pipeline; for Notebooks, use jobType=DefaultJob.
2. The Base URL to be used is https://api.fabric.microsoft.com/v1. The Route Format for the GET request is:
   /workspaces/{workspaceId}/items/{itemId}/jobs/{jobType}/schedules
   For example:
   a. Pipelines:  .../jobs/Pipeline/schedules
   b. Notebooks:  .../jobs/DefaultJob/schedules
3. Ensure that the Azure AD application (service principal) has the following Microsoft Graph API scopes: Item.Read.All, Pipeline.Read.All, and Notebook.Read.All. Also, grant admin consent for these permissions and assign the app either Reader or Contributor role in each workspace.
4. The functionality is available via the Job Scheduler API. Use the configuration table to iterate through workspaces and items. The Schedule API can be used to fetch startDateTime and endDateTime. Implement logic within your monitoring pipeline to compare endDateTime against the current date and trigger alerts based on specific thresholds (for example, 30, 60, or 90 days prior to expiry).

Additionally, kindly refer to the following links for further guidance:
Job Scheduler - List Item Schedules - REST API (Core) | Microsoft Learn
Job Scheduler - Run On Demand Item Job - REST API (Core) | Microsoft Learn
Enable service principal authentication for admin APIs - Microsoft Fabric | Microsoft Learn
How to monitor pipeline runs - Microsoft Fabric | Microsoft Learn

We hope the above information will prove helpful in resolving your issue. Should you have any further queries, please do not hesitate to contact the Microsoft Fabric community.

Thank you.

[liney_marcela]

Hi,

Thank you very much for your help and the information provided. However, upon reviewing the official Microsoft Graph documentation, I couldn't find the permissions Item.Read.All, Pipeline.Read.All, and Notebook.Read.All.

Could you please indicate under which service or API I can find these permissions? I greatly appreciate your guidance.

Best regards,

Liney B.