API Release Notes
See Finding Your Alation Version for help determining which version of Alation you're using.
2025.1 API Release Notes
New
Delete Lineage API v3
As a beta release, we've added a new version of the Lineage API with a single Delete lineage (beta) endpoint for now. The new DELETE endpoint offers a new parameter, dataflow_key
, which enables you to specify the dataflow to delete in addition to the source and target object. (AL-179124)
Joins API
We've added new endpoints to get information on joins that have been cataloged in Alation. The endpoints are part of the Relational Integration API.
- Get joins by table ID
- Get joins by table name
- Get joins by data source
- Get joins by column (attribute) ID
- Get joins by column (attribute) name
(AL-183255)
Updated
Relational Integration API
We've added a new values
parameter that will enable you to specify which fields to return when getting schemas, tables, and columns. Limiting which fields to return can improve API performance significantly, especially when you exclude the custom_fields
field. The fields
parameter offers the same functionality and is still available for compatibility purposes. We're adding the values
parameter for better consistency with other APIs. (AL-179358)
Template Visual Config API
We've added a new property, collection_type_id
, to the Create a new visual config endpoint. This property is required when creating Document templates and will enable you to assign a Document template to a Document Hub. (AL-182252)
Fixed
Documents and Terms APIs
We've fixed a bug in the Documents and Terms APIs where an error would occur when the folder_id
parameter value referred to a folder that contained subfolders. (AL-183044)
Documents API
We've removed the document_hub_id
parameter from the Update documents endpoint. It's not necessary, since document IDs are unique even across document hubs, and the parameter was already being ignored. It's not possible to move documents to another hub using this endpoint. (AL-183044)
OCF Data Sources API
- We fixed a bug where the
db_password
parameter of the Create a datasource endpoint was being treated as required even though it isn't required. (AL-180160) - The
schemas
parameter on the Update metadata extraction configurations endpoint is now correctly identified as a simple array rather than an array of arrays. This fixes a mistake in the documentation. (AL-180173)
Relational Integration API
We've updated the documentation on the Get columns endpoint to indicate that the URL can have a maximum of 1,800 characters, after percent encoding of reserved characters. (AL-180993)
Known issues
There is a known issue with the Trust Check Flags API where GET calls will return the subject
id
in a UUID format instead of an integer. This will be addressed in the next release. (AL-186638)
Deprecation notices
Upload Logical Metadata (ULM) API
The Upload Logical Metadata (ULM) API has now been deprecated.
Definitions
- Deprecation: The API is no longer supported. The API will still be accessible to end users.
- Sunset: The API is no longer supported. The API will be removed from the product and will no longer function.
What is happening
- ULM Deprecation: 2025.1 Release (March 2025)
- ULM Sunset: 2025.3 Release (September 2025)
What to expect
- Alation does not recommend the usage of the ULM API. Use the alternative APIs listed in the table below instead.
- Alation will no longer prioritize support efforts on the ULM API after the 2025.1 release and reserves the right to decline support requests.
If you have any questions, please contact Alation Support.
Alternative APIs
Object Type | Fields | Alternative API |
---|---|---|
Article | Title and body | Articles API |
Article | Custom field values | None. Migrate articles to Document Hubs and then use the Documents API. See Risks with the ULM API . |
Data source (OCF) object | Title and description | Data Sources API (OCF) |
Data source (native) object | Title and description | Data Sources API |
Document | Title, description, and custom field values | Documents API |
Schema, table, and column | Title and description | Relational Integration API |
Schema, table, and column | Custom field values | Custom Field Values Async API |
Term | Title, description, and custom field values | Terms API |
Other supported object types | Custom field values | Custom Field Values Async API |
Risks with the ULM API
Alation Cloud Services (ACS) customers using the Upload Logical Metadata (ULM) API may not see Title, Description, or Custom Field Value updates reflected correctly in the Alation UI.
Why this is a risk
Alation is enabling Logical Metadata Services for all customers on ACS. This is a new infrastructure designed to bring performance and scalability benefits anywhere title, description, and custom field value metadata is involved. When Logical Metadata Services are enabled, the Alation UI serves content from Logical Metadata Services, instead of a legacy infrastructure. Updates made via the Upload Logical Metadata (ULM) API reflect in the legacy infrastructure only, and are not supported by Logical Metadata Services.
What are my options
Alation Cloud Service
- The ULM API is deprecated as of the 2025.1 Release (March 2025). Alation does not recommend using the ULM API. Use alternative APIs listed above instead.
- Temporary opt-outs of Logical Metadata Services enablement have also ceased as of 2025.1.
Customer-managed (on-premises)
- Alation does not recommend using the ULM API. Use alternative APIs listed above instead. The ULM API is deprecated as of the 2025.1 Release (March 2025).
- No action is required regarding Logical Metadata Services enablement. Logical Metadata Services are not available in customer-managed instances of Alation.
Updated 3 days ago