Skip to content

Sidra API

Sidra exposes a range of APIs to support integration with third-party tools and custom applications. These APIs enable interaction with core platform components such as the metadata model, Data Ingestion processes, and more.

Swagger Access

Sidra APIs are continuously evolving, and endpoint definitions may change between versions. To explore the available endpoints for your installation, Sidra includes a built-in Swagger documentation page.

This can be accessed by visiting the base URL of your deployed Sidra API, typically hosted in Azure App Service. The default URL pattern is:

https://core-<<name of the installation>>-<<environment>>-wst-api.azurewebsites.net

For example:

https://core-mycompany-dev-wst-api.azurewebsites.net

Note: You may see two Azure App Services in your resource group—one for the Sidra API (-api) and one for the Web frontend (-frontend). This documentation refers to the Sidra API only.

Identifiers

Sidra APIs commonly use two types of identifiers for referencing elements:

  • Identifier: A numeric ID used to distinguish entities of the same type. It is typically autogenerated and referred to as Id (e.g., Provider.Id) or Id<EntityName> in foreign key relationships (e.g., Entity.IdProvider).
  • Item Identifier: A globally unique identifier (GUID) that ensures identity across Sidra installations. Referred to as ItemId.

API Modules

Sidra APIs are organized into modules that group related functionality. Below is an overview of the modules and their contents:

Module Endpoints Description
Data Intake DataSource, Plugin, Provider, Entity, Asset, Attributes, Tags CRUD operations for metadata entities, including Assets and associated resources.
Data Factory ActivityTemplates, DataFactories, DataSetTemplates, Pipelines, PipelineTemplates, Triggers, TriggerTemplates, PII Operations related to Azure Data Factory orchestration and metadata.
Data Storage Unit ClusterTypes, DataStorageUnits, DataIntake, LandingZones, SearchServices, Storages, StorageRoles Endpoints for managing DSUs and data lake components.
Management App, Configuration, DataFactoryMetricLogs, Image, Logs, Installation, Notifications, Permissions, TypeTranslation, ReleaseNotes, Service Retrieve installation-level data such as logs, notifications, and system configuration.
Identity Identity, IdentityServerUsers Authentication-related endpoints. Sidra uses Keycloak for identity and access management.
Ingestion Inference, Ingestion API endpoints to initiate or manage data ingestion processes for registered assets.
Data Querying Query Endpoints to query data via the Sidra Query API. A tutorial is available for getting started.