Link API changelog
All notable changes to Link API will be documented here.
No addition in this version
Modified the maximum length of the "name" property of "destination" resources from 100 to 140 characters.
No deprecation in this version
No removal in this version
Added "tags" property to "source", "destination" and "pool" resources. Up to 20 tags can be set on each resource, each tag can be up to 30 characters. Replaces and extends the former "labels" property.
Added "tags" query parameter on route to list sources and destinations. Allows to filter and return only sources and destinations containing all specified tags.
"start_timezone" and "end_timezone" properties of "scheduled_event" resource now accepts "Etc/UTC" as a value. Allows to schedule with absolute time alternatively to localized time.
No deprecation in this version
Removed "labels" property of "source", "destination" and "pool" resources. New "tags" property of these resources extends the capabilities and should be used as replacements.
Added destination "query" parameter on route to list "scheduled_event" resources. Allows to filter and return only scheduled events specifically using one of the destination.
Added" scheduled_resources" property on "scheduled_event" resource. The value is a list of objects allowing to specify sources to be scheduled, either for all their linked destinations, or limited to specified destinations.
Added "start_timezone" and "end_timezone" properties to "scheduled_event" resource. Time zone can now be expressed independently for start and end time. Supported values are specified as an enumeration.
Added "started_at" and "ended_at" properties to "scheduled_event" resource. Provides explicit action timestamps, useful with scheduled events that use relative time (now, after 4 hours).
"start_time" property of "scheduled_event" now accepts now as a value, alternatively to a timestamp. It allows to start a scheduled event immediately while specifying its end time.
"end_time" property of "scheduled_event" now accepts a duration relative to the start time, as a number of minutes or hours.
"end_time" property of "scheduled_event" now accepts now as a value on PATCH request when event is started. It allows to stop a scheduled event immediately.
The "state" property of a "scheduled_event" takes a value among scheduled, started and finished.
No deprecation in this version
Removed support of POST and DELETE requests on "sender", "receiver", "input_stream" and "output_stream" resources. These resources should now be created and deleted in the "source" and "destination" creation and deletion request, respectively.
Removed "labels" property on "sender", "receiver", "input_stream" and "output_stream" resources. Labels remain available on parent resources "source" and "destination", respectively.
Removed "source_uuids" property of "scheduled_event" resource. Sources used in a scheduled event are now specified in the new "scheduled_resources" property.
Removed "timezone" property of "scheduled_event" resource. Properties "start_timezone" and "end_timezone" are respective replacements for "start_time" and "end_time".
Removed "enabled_links" property of "source" resource. Streaming is controlled using the "enabled" property on input streams of a source and on output streams of linked destinations.
Removed discontinued values "standard", "high" and "premium" in "availability_mode" property of "source" and "destination" resources.
Version predating detailed historization of API changes.
Link API version 1.2.1 - 2024-10-02
Added
No addition in this version
Changed
Modified the maximum length of the "name" property of "destination" resources from 100 to 140 characters.
Deprecated
No deprecation in this version
Removed
No removal in this version
Link API version 1.2.0 - 2024-09-27
Added
Added "tags" property to "source", "destination" and "pool" resources. Up to 20 tags can be set on each resource, each tag can be up to 30 characters. Replaces and extends the former "labels" property.
Added "tags" query parameter on route to list sources and destinations. Allows to filter and return only sources and destinations containing all specified tags.
Changed
"start_timezone" and "end_timezone" properties of "scheduled_event" resource now accepts "Etc/UTC" as a value. Allows to schedule with absolute time alternatively to localized time.
Deprecated
No deprecation in this version
Removed
Removed "labels" property of "source", "destination" and "pool" resources. New "tags" property of these resources extends the capabilities and should be used as replacements.
Link API version 1.1.0 - 2024-09-16
Added
Added destination "query" parameter on route to list "scheduled_event" resources. Allows to filter and return only scheduled events specifically using one of the destination.
Added" scheduled_resources" property on "scheduled_event" resource. The value is a list of objects allowing to specify sources to be scheduled, either for all their linked destinations, or limited to specified destinations.
Added "start_timezone" and "end_timezone" properties to "scheduled_event" resource. Time zone can now be expressed independently for start and end time. Supported values are specified as an enumeration.
Added "started_at" and "ended_at" properties to "scheduled_event" resource. Provides explicit action timestamps, useful with scheduled events that use relative time (now, after 4 hours).
Changed
"start_time" property of "scheduled_event" now accepts now as a value, alternatively to a timestamp. It allows to start a scheduled event immediately while specifying its end time.
"end_time" property of "scheduled_event" now accepts a duration relative to the start time, as a number of minutes or hours.
"end_time" property of "scheduled_event" now accepts now as a value on PATCH request when event is started. It allows to stop a scheduled event immediately.
The "state" property of a "scheduled_event" takes a value among scheduled, started and finished.
Deprecated
No deprecation in this version
Removed
Removed support of POST and DELETE requests on "sender", "receiver", "input_stream" and "output_stream" resources. These resources should now be created and deleted in the "source" and "destination" creation and deletion request, respectively.
Removed "labels" property on "sender", "receiver", "input_stream" and "output_stream" resources. Labels remain available on parent resources "source" and "destination", respectively.
Removed "source_uuids" property of "scheduled_event" resource. Sources used in a scheduled event are now specified in the new "scheduled_resources" property.
Removed "timezone" property of "scheduled_event" resource. Properties "start_timezone" and "end_timezone" are respective replacements for "start_time" and "end_time".
Removed "enabled_links" property of "source" resource. Streaming is controlled using the "enabled" property on input streams of a source and on output streams of linked destinations.
Removed discontinued values "standard", "high" and "premium" in "availability_mode" property of "source" and "destination" resources.
Link API version 1.0.0
Version predating detailed historization of API changes.
Updated on: 02/10/2024
Thank you!