See Finding Your Alation Version for help determining which version of Alation you're using.

2025.1.5 API Release Notes

New

Logging API

• Added two new API endpoints to export and download Alation server logs.
  • POST /logs/audit/export/: Prepares audit logs for download and retrieves the task ID.
  • GET /logs/audit/download/: Retrieves and downloads the audit log files using the task ID. (AL-180289)

Updated

Aggregated Context API

• The Aggregated Context API is now generally available. The "beta" label has been removed from the API reference. This release includes several new capabilities:
  • BI object support: The Context API now supports BI objects, including BI folder, BI report, BI report field. (AL-197854)
  • Support for source_comment field: The Context API now supports the source_comment field from schema, table, column and BI objects in the signature. (AL-197218)
  • Support for object_id and object_type fields: These fields are now available in the signature for all object types (schemas, tables, columns, documentation, queries, BI objects) to support integration with other Alation APIs and AI Agent SDK tools. These fields are returned only when explicitly requested via the fields_required key. (AL-197219)
  • New parameter: rich_text_format: Default: html—Returns rich text fields (descriptions and custom fields) in HTML format. Option: text—returns plain text with no HTML tags. (AL-194757)
  • New parameter: omit_empty: This parameter controls whether empty fields are included in the response. Default: false—All fields are returned, including those with empty values. When set to true, empty fields are omitted from the response. (AL-194759)

Image Resolution Query Parameter in BI Source API

• Added support for a new query parameter for image resolution to BI Source API. This parameter allows users to upload and retrieve high resolution images for a BI report. Use one of the following values:
  • low: Retrieve the low quality image
  • high: Retrieve the high quality image
  • high_fallback_to_low: Only used with the GET endpoint. Returns a high-quality image when available; otherwise, falls back to a lower-quality image. (AL-196280)

For example,
GET https://mydatacatalog.com/integration/v2/bi/server/1/report/348752/image/?resolution=high

Datasources API and Data Sources API (OCF)

• The Delete endpoints for RDBMS data sources now support hard deletion (permanent deletion) when the feature flag alation.ocf.datasource.rdbms.hard_delete.enabled is enabled.
  • Data Sources API
  • Data Sources API (OCF) (AL-196700)

Fixed

• Fixed an issue where Custom Field Values API and Relational Integration API were returning source tag values in an internal format. (AL-190551)
• Fixed an issue where Otypes API failed to return the column object type. (AL-195045)
• Fixed an issue where the Relational Integration API would time out with a 504 error when using a custom field filter. (AL-189084)