PBRS REST API Overview and Documentation Index

Review status: Draft for Development and Support review. Routes and models labelled validation required must be tested against the supported PBRS build before publication.

What the PBRS REST API does

The PBRS REST API allows an approved external application to work with PBRS through HTTP requests and JSON responses. It is intended for server-side integrations, administrative tooling, enterprise schedulers, deployment processes, and controlled portals that need to trigger or configure reporting without relying entirely on the PBRS desktop interface.

The API runs as a Windows service on the PBRS server. The documented default API base address is http://[pbrsserver]:9000/api, although the host, port, protocol, firewall rules, and security configuration must follow the deployment approved for your environment.

Documented capability areas

• Check whether the API and PBRS scheduler are available, and start or stop the scheduler through administrative operations.
• Traverse PBRS folders and resolve schedule identifiers from a folder path, schedule name, and schedule type.
• Discover configured Power BI accounts, workspaces, reports, dashboards, report visuals, paginated reports, and SSRS accounts.
• Execute existing schedules synchronously or asynchronously, monitor their status, inspect the execution queue, check free execution threads, and attempt cancellation.
• List and retrieve Power BI and paginated-report single schedules.
• Create Power BI schedules and Power BI paginated-report schedules, including the documented bulk paginated-schedule workflow once its canonical route is confirmed.
• Update Power BI single schedules and add, update, or delete email destinations.
• Configure Power BI filters, paginated parameters, rendering settings, recurrence, and Power BI visual data-only Excel exports.
• List, retrieve, create, and delete Power BI package schedules, including documented data-driver and group-by-email settings.
• Export schedule definitions through the PBRS interface using the REST API workflow.
• Support PBRS collaboration and failover configurations when all server and database prerequisites are met.

Choose the right guide

Use the validated contract

Use the Postman collection that matches the installed PBRS build while developing an integration. Several older public examples contain inconsistent routes, request methods, and property spellings. Do not copy a disputed example into production code until Development has confirmed it for the target build.

Security: Keep API client secrets, user credentials, and access tokens on trusted servers. Do not expose them in browser code, tickets, screenshots, source control, or application logs.

Use this documentation set

Start with installation and authentication, then follow a task guide. Use the endpoint, model, error and version references when implementing production code.

Capability boundaries

The API can execute any supported existing PBRS schedule type listed in the execution guide. That does not mean the API can create, update, or delete every schedule family or destination. The verified authoring contract currently covers Power BI single schedules, Power BI paginated schedules, Power BI package schedules, email destinations, and the support-evidenced paginated-parameter update. Treat other PBRS product capabilities as separate from the public REST API contract until Development validates an endpoint.

Documentation standard: Record the PBRS build used for verification, test in a non-production environment, redact credentials and customer data, and confirm the saved PBRS state after every write.