API Overview

Developer

The DataCentral REST API allows external applications and internal tooling to interact programmatically with your DataCentral Instance and Tenants.

You can use the API to:

• Embed reports securely into your own custom applications (ISV Embedding).
• Provision and manage users, roles, and Organizational Units (OUs).
• Import Power BI items and configure Row-Level Security.
• Automate workflows using webhooks and Tasks.

---

1. Base URL

All API requests are routed through your specific Instance API domain. Endpoints follow the ASP.NET Boilerplate convention:

https://api.{instancename}.datacentral.ai/api/services/app/{Service}/{Method}

For example:

https://api.{instancename}.datacentral.ai/api/services/app/ItemLinks/CreateEncryptedKey

(Replace {instancename} with the name of your DataCentral instance. If you are unsure of your instance name, contact your Host Administrator.)

Exploring Available Routes

All available API routes are documented via an interactive Swagger UI hosted at the base URL of your instance API:

https://api.{instancename}.datacentral.ai

Navigating to this URL in a browser will present a login prompt. To log in as a Host user, leave the Tenancy Name input blank. To access a specific Tenant, enter the tenancy name in the input field. Then provide your username and password to access the Swagger interface, where you can browse all endpoints, view request/response schemas, and test API calls directly.

2. Conventions

The DataCentral API follows standard RESTful conventions:

• Format: All request payloads and response bodies are formatted as JSON (application/json).
• Timestamps: All dates and times are returned in ISO 8601 format (e.g., 2026-02-01T12:30:00Z).
• Pagination: Endpoints that return collections of objects support pagination using page and pageSize query parameters.
• Errors: Unsuccessful requests return a standardized error object containing an error code and a human-readable message.

3. Object Model Summary

The API interacts with the following core objects:

Object	Description
Tenant	A specific tenant environment containing its own settings, users, and content.
User	An identity (Entra ID, User Pass, Mobile ID, or OTP) that can log in to the tenant.
Role	A System, Report, or RLS role that defines access permissions.
OU	An Organizational Unit used to group users hierarchically.
Item	A Power BI Report, Dashboard, or App imported into the tenant.

---

Next Steps

Before you can make API calls, you must understand how to authenticate. Proceed to the Authentication guide to learn how to generate API Keys and Tenant Passphrases.