API Changelog

Learn about new features, updates, improvements, and bug fixes to the ISAAC API.

‍

2.5.3 - March 5th, 2026

Bug Fixes

PreviewPlay heartbeat messages do not return the expected payload. The property objectsIDs has been removed (not expected), the property duration now returns an integer instead of a string (string was not expected), and the property objects now returns an array of integers [ISAAC-S-2067].

InstantPlay heartbeat messages do not return the expected payload. The properties group and group_name are now returned with the same value to preserve backward compatibility. However, group_name is marked as deprecated and shouldn't be used anymore, as it will be removed [ISAAC-S-2066].

PreviewStop heartbeat messages do not return the expected payload. The property playable returns an object with empty property values instead of an empty object [ISAAC-S-2068].

When a Composition Template has 3 media selectors but only 2 media are set in the Composition, the Playables include one additional associated media [ISAAC-S-2090].

URLs in Compositions GET /api/v1/compositions/:id omit the protocol [ISAAC-S-2081].

REST API endpoint GET /api/v1/objects/[image-sequence-id]?limit=5000 returns a 404 [ISAAC-S-2135].

‍

2.5.2 - December 15th, 2025

Bug Fixes

REST API endpoint GET /api/v1/objects/{bucket-id} only returns the first 50 objects. This value is the default page size introduced with pagination support in 2.5.x [ISAAC-S-2000].

The Instant Play's Playable payload does not return the fields objects and group_name properly anymore, which can break the Instant Play feature in some integrations [ISAAC-S-2017].

The behavior of the self link returned in the schedule items for a Playable does not behave as in 2.4.x versions. The link no longer has a trailing / (which alone doesn't change the link behavior). However, if the consumer adds back the /, the returned payload is no longer an object but an array of objects. An array of objects is only expected if the link points to a folder, such as an Image Sequence [ISAAC-S-2017].

REST API endpoint GET /api/v1/objects/cms-media/_advancedSearch?limit=xxx returns objects in two different structures [ISAAC-S-2056].

‍

2.5.1 - October 6th, 2025

Bug Fixes

REST API endpoint GET /api/v1/objects/{id} is no longer returning the objects if the id points to a folder (observed when fetching image sequences) [ISAAC-S-1958].
REST API endpoint GET /api/v1/players/{id} does return an empty defaultState.mediaDetails property when a Playable is defined as default loop [ISAAC-S-1968]

‍

2.5.0 - August 1st, 2025

Bug Fixes

REST API endpoint POST /variables/{variable_id}/value does not clear the variable value when an empty value is passed [ISAAC-S-1424].
REST API endpoint PUT /api/v1/events does not allow changing the externalRef property [ISAAC-S-1212].
REST API endpoint PUT /api/v1/subsystems does not allow changing the externalRef property [ISAAC-S-1211].
REST API endpoints PUT /api/v1/notifications/clear, PUT /api/v1/notifications/show, PUT /api/v1/notifications/:id/clear, PUT /api/v1/notifications/:id/show do return incorrect messages [ISAAC-S-1272].
REST API endpoints PUT/POST /api/v1/parameters does not prevent using the same name twice [ISAAC-S-1284].
REST API endpoint PUT /api/v1/asset resets certain properties such as metadata.ip_address if not provided, despite the Patch Put nature of this endpoint [ISAAC-S-1364].
REST API endpoints /api/v1/logs do not enforce allowed severity values [ISAAC-S-1294].
REST API endpoints PUT/POST /api/v1/presets do not enforce uniqueness of the displayName property [ISAAC-S-1357].
REST API endpoint PUT /api/v1/players returns a 409 "subsystem externalId or/and displayName already exists" error, even when updating a different property [ISAAC-S-1371].
REST API endpoint POST/PUT /api/v1/backups does not enforce uniqueness of the displayName property [ISAAC-S-1379].
REST API endpoint PUT /api/v1/subsystems/{subsystemId}/compositions/{playableId} does not provide the templatePath._id property in the returned payload [ISAAC-S-1217].
REST API endpoints GET /api/v1/objects do not return _links property as defined in swagger [ISAAC-S-1448].
REST API endpoint POST /api/v1/subsystems does not prohibit changing the property directMediaPlayback when the feature is not allowed in the module license definition [ISAAC-S-1408].
REST API PUT /api/v1/controlpanels returns 201 instead of 200 [ISAAC-S-1433].
REST API endpoint PUT /api/v1/controlpanels for registered panels does not allow changing the externalRef property [ISAAC-S-1277].
REST API endpoint PUT /api/v1/compositions does not allow adding associated players (even if these players are defined in the Composition Template) and returns a 409 error [ISAAC-S-1462].
REST API endpoints POST/PUT /api/v1/controlpanels do not enforce uniqueness of displayName and externalRef properties [ISAAC-S-1516].
REST API endpoints GET /api/v1/controlpanels, GET /api/v1/controlpanels/:id, PATCH /api/v1/controlpanels/:id do return an extra, irrelevant bucketName property [ISAAC-S-1513].
REST API endpoints PUT /api/v1/controlpanels, PATCH /api/v1/controlpanels/:id do not treat the properties type, subsystemId, and subsystemExternalId as immutable [ISAAC-S-1518].
REST API endpoint PUT /api/v1/infra/assets/:id returns a 500 error when profileType property is not provided or empty [ISAAC-S-1677].
REST API endpoint PUT /api/v1/subsystems/:id/action returns the property zoneId as an array of integers instead of an integer [ISAAC-S-1729].
REST API endpoint POST /api/v1/controlpanels for registered panels returns a 404 when mandatory properties are missing even when the provided subsystemExternalId property references an existing Subsystem [ISAAC-S-1759].
REST API endpoint POST /api/v1/objects/cms-media/_advancedSearch?csv=true&limit=100 does not take into account the limit parameter when returning the results [ISAAC-S-1744].
REST API endpoint POST /api/v1/users returns the session property as an object instead of an integer [ISAAC-S-1785].
REST API endpoint DELETE /api/v1/subsystems/:id returns an empty object in the controlpanels array property instead of an empty array [ISAAC-S-1789].
The Swagger definition for the endpoint PUT /api/v1/subsystems/:id/action documents the property parameter instead of parameters [ISAAC-S-1728].
Some Unused/Unavailable endpoints have been removed from swagger [ISAAC-S-1260].
The character / was allowed in variables' externalRef property which prohibits using endpoint where externalRef is referenced [ISAAC-S-1817]

2.4.7 - August 1st, 2025

Improvements

REST API endpoint GET /schedule, when using the If-Modified-Since header, does not always return expected data. This is caused by the input time using local time whereas the last build reference time is in UTC [ISAAC-S-1916].
The Slider composition element cannot be set to 0 [ISAAC-A-3247].

Known Issues:

The value of a variable cannot be cleared by setting it to an empty string [ISAAC-S-1424].

‍

2.4.4 - January 10th, 2025

Improvements

REST API endpoint PUT /variables/{id} returns a 502 when the healthCheck property contains unexpected empty strings [ISAAC-A-1643].

‍

2.4.1 - July 24th, 2024

Improvements

For better readability and audience's interest, the changelog for ISAAC API has been removed from the product Changelog and is now available here, as well as online on the Integration Partner Portal's page and on-demand. [ISAAC-S-1265].
The behavior of ISAAC API with regards to True PUT/PATCH methods has been documented in the API Guide [ISAAC-S-1254].
The REST API /api/v1/controlpanels endpoints now accept relative paths for Control Panel's type iframe, relying on ISAAC address for the full Control Panel URL [ISAAC-S-1338].

Bug Fixes

Documentation for heartbeat messages is missing in swagger and the API Guide [ISAAC-S-1347].
Heartbeat Identify messages are not sent even when a module states it supports it, except for BrightSign module [ISAAC-S-1318].

‍

2.4.0 - May 31st, 2024

Improvements

The REST API DELETE /api/v1/assets is now protected against the deletion of Assets that are owned and managed by other ISAAC entities.
The REST API /api/v1/subsystem/:id/compositions endpoint have been deprecated [ISAAC-S-1215]

Bug Fixes

REST API POST/PUT /api/v1/events does not enforce uniqueness of displayName property [ISAAC-S-975].
REST API POST/PUT /api/v1/compositions does not enforce uniqueness of displayName property [ISAAC-S-1128].
REST API POST/PUT /api/v1/playables does not enforce uniqueness of displayName property [ISAAC-S-1102].
REST API GET /api/v1/compositions returned payload templatePath property does not match the swagger schema, it should be an object with only the name and the group of the template [ISAAC-S-1099].
REST API DELETE /api/v1/playables/orphan swagger definition for the returned payload is incorrect [ISAAC-S-1098].
REST API GET /api/v1/users swagger definition for the returned payload is incorrect [ISAAC-S-903].
REST API POST/PUT /api/v1/assets does not enforce uniqueness of displayName property [ISAAC-S-883].
REST API GET /api/v1/infra/assets/{id}/historicCounts endpoint returned payload is missing the metricsChangeHistory property in the _links object [ISAAC-S-881].
REST API POST /api/v1/infra/assets endpoint returned payload is missing the self property in the _links object [ISAAC-S-870].
REST API PUT /api/v1/assets clears fields that are not specified in the payload instead of preserving their values [ISAAC-S-879].
REST API GET /api/v1/assets endpoint payload does return an invalid _updatedAt value when the property is not set [ISAAC-S-871].
REST API DELETE /api/v1/variables endpoint does not protect the deletion of metrics (variables) that are owned and managed by an Asset [ISAAC-S-873].
REST API GET /api/v1/assets/{id}/historicCounts endpoint returns lastValue property as "undefined" value in its payload instead of "" when the value is not defined [ISAAC-S-867].
REST API POST /api/v1/controlpanels endpoint expects a location parameter, but if omitted, it'll default to available even if the payload contains "location": "registered" [ISAAC-S-1178].
REST API GET /api/v1/playables/{id}/copyToPlayerStatus response missed the _links property as defined in its swagger definition [ISAAC-S-1111].
REST API PUT /api/v1/subsystem/:id/variables/:externalRef and PUT /api/v1/subsystem/:id/events/:externalRef endpoints don't handle the externalRef value correctly, if the externalRef property passed in the payload is different from the parameter value [ISAAC-S-1210/ISAAC-S-1206].
REST API GET /api/v1/subsystems/... endpoints do not return itemCounts' properties as integers [ISAAC-S-1199/ISAAC-S-1221/ISAAC-S-1198].
REST API GET /api/v1/subsystems/... endpoints do not return the container property [ISAAC-S-1220].
The uniqueness of the property externalId of subsystems is not enforced which can cause duplicated values [ISAAC-S-1222].
The REST API GET /api/v1/subsystems/:externalRef/variables/:externalVarRef returned payload does not match its swagger definition, missing returned properties [ISAAC-S-1202].
Calling the REST API PUT /api/v1/events without the displayName or the description fields provided overwrites them to empty [ISAAC-S-979].

2.3.3 - December 8th, 2023

Improvements & Bug Fixes

The REST API endpoints PUT /api/v1/backups/:id/verify & PUT /api/v1/backups/:id/restore do not return an expected 404 error, when the given backup id doesn't exist [ISAAC-S-802]
The REST API endpoints POST /api/v1/notifications/<id>/show, POST /api/v1/notifications/<id>/clear and POST /api/v1/notifications/<id>/action do not return 404 when the given id does not exist [ISAAC-S-804]
The REST API endpoint POST /api/v1/users does return 201 instead of 403 when the maximum number of allowed users is reached [ISAAC-S-783]
The REST API endpoint GET /api/v1/playables/<id>/instances does not return an expected 404 error, when the given playable id doesn't exist [ISAAC-S-805]
The REST API endpoint GET /api/v1/players/<id>/defaultState does not return an expected 404 error, when the given Player id doesn't exist [ISAAC-S-807]
The REST API endpoint PUT /api/v1/roles/<id> does not return an expected 404 error, when the given role id doesn't exist [ISAAC-S-809]
The REST API endpoint POST /api/v1/users documentation does not indicate the password property as mandatory [ISAAC-S-806]
The REST API endpoint POST /api/v1/users response payload is not properly documented [ISAAC-S-808]
The REST API endpoint GET /api/v1/infra/assets/<id>/network/historicCounts does not return 404 when the asset id doesn't exist but instead a pseudo answer which contains the non existing given assetId [ISAAC-S-803]
Some of the REST API endpoints' documentation don't have the 404 response documented [ISAAC-S-641]
Some of the REST API endpoints in /api/v1/settings, /api/v1/subsystems, /api/v1/license and /api/v1/webhook have incorrect or missing documentation [ISAAC-S-642]
Some of the REST API endpoints in /api/v1/users, /api/v1/roles, /api/v1/variables, /api/v1/infra/assets and /api/v1/usertemplates have incorrect or missing documentation in 200, 400 and 401 responses [ISAAC-S-792/ISAAC-S-793]
Some of the REST API endpoints in /api/v1/playlists, /api/v1/schedules and /api/v1/zones have incorrect or missing documentation in 200, 404 and 500 responses as well as headers' format [ISAAC-S-794/ISAAC-S-834]
Some of the REST API endpoints in /api/v1/playables and /api/v1/players have incorrect or missing documentation (responses payload) [ISAAC-S-795]
The REST API endpoints in /api/v1/alerts documentation for returned alerts payload is incorrect [ISAAC-S-835]
The REST API endpoints POST/PUT /alerts return 200 instead of 409 if the name of the alert is set to an already existing one [ISAAC-S-840]

2.3.2 - October 12th, 2023

Bug Fixes

The REST API endpoints DELETE /api/v1/settings/background and DELETE /api/v1/settings/logo were documented although not implemented [ISAAC-S-724]
The REST API endpoint DELETE /api/v1/playlists/{id} does not return any payload [ISAAC-S-722]
The REST API endpoint GET /variables/{id}/history returns invalid data for some metrics (unexpected objets) [ISAAC-S-714]
The REST API endpoint `DELETE /api/v1/integrations/webhooks/{id} returns a webhook object with empty properties instead of the expected response payload [ISAAC-S-708]
The REST API endpoint DELETE /api/v1/schedule/zones/{id} response payload does not contain impacted items [ISAAC-S-707]
The REST API endpoints GET/PUT /subsystems/{externalId}/variables/{externalRef}/lastValue are not documented properly [ISAAC-S-732]
The REST API endpoint GET /players?container={id} does not filter the Players properly and is returning other Players as well [ISAAC-S-741]
Some REST API DELETE endpoints don't have the payload of 200 return code properly documented [ISAAC-S-640]
The REST API endpoint POST /users documentation does not specify that it requires the roleIds property to be provided [ISAAC-S-742]
The swagger specification for the endpoint DELETE /api/v1/subsystems/{id} is incorrect and the endpoint does not properly return the list of affected items [ISAAC-S-726]
Instant Play feature usage is missing in the API Guide [ISAAC-S-733/ISAAC-S-683]

‍

2.3.1 - August 29th, 2023

Improvments

Improvement of the API Guide on externalRef parameter and heartbeat endpoint usage [ISAAC-S-637/ISAAC-S-682]

Bug Fixes

The REST API or Schedule TCP payloads for playables and events items do not provide externalRef property [ISAAC-S-634]
The REST API GET /scheduledItems?beforeCount=x endpoint returns more than x items in the past [ISAAC-S-674]
The REST API api/v1/schedule/calendars endpoints are incorrectly documented into the swagger specifications. Certain endpoints' definition do not exist and have been removed [ISAAC-S-633]
The REST API PUT /subsystems/{externalId}/variables/{externalRef} endpoint property availableInSubsystem is defaulted to false instead of true, which causes the variable to appear as a broken link [ISAAC-S-668]
The REST API POST /notifications/show endpoint clears notifications instead of marking them as shown [ISAAC-S-663]
The REST API PUT /variables/{id} endpoint returns a 500 error when the property healthGracePeriod is greater than 0 (> 0) [ISAAC-S-647]
The REST API PUT /api/v1/variables/{id} endpoint property healthEnabled is defaulted to false instead of true, which causes the variable health state to not refresh anymore when the health status changes [ISAAC-S-645]
The REST API DELETE /api/v1/events/{systemId}/{externalRef} endpoint does not work if the externalRef value only contains numerical characters [ISAAC-S-627]
The REST API PUT /api/v1/variable/lastValue/{systemId}/{variableName} endpoint is not working anymore which breaks backward compatibility [ISAAC-S-614]

2.3.0 - July 21st, 2023

Improvements

A new API Guide provides guidance for integrating Subsystems with ISAAC

Bug Fixes

REST API GET /api/v1/schedule?objectList=true response has an empty object in it which is not expected. [ISAAC-S-353]
REST API user panels endpoints (ex GET /api/v1//users/{id}?availablePanels) return a 500 error message. [ISAAC-S-442]
Some REST API endpoints are returning the header Content-Type as application/json; charset=utf-8 instead of application/json [ISAAC-S-376]
Newly created panels are not returned by GET /api/v1//users/{id}?availablePanels endpoint [ISAAC-S-383]
REST API GET /api/v1//platform/host/actions/system/shutdown return a 500 error message, although the shutdown did happen [ISAAC-S-563]
REST API DELETE /api/v1/events/{{ID}} accepts random text as ID, which causes deletion of unwanted event [ISAAC-S-562]
REST API, some endpoints such as GET /api/v1/users randomly return 500 error [ISAAC-S-465]
REST API GET /api/v1/schedule returns 500 Internal Server Error if the header if-modified-since is passed, which breaks modules' integration using it [ISAAC-S-603]
REST API GET /api/v1/schedule items payload's properties startTimeLocal and endTimeLocal are missing time fraction part, which may break some modules' integration [ISAAC-S-595]
REST API GET /api/v1/schedule?subsystemExternalId= does not return 404 Not Found as expected when a non existing subsystemExternalId parameter is provided [ISAAC-S-600]
REST API PUT /api/v1/controlpanels/{id} returns 500 Internal Server error when the full control panel object is provided as payload [ISAAC-S-594]
REST API PUT/POST /api/v1/variables endpoints do not accept the playload property subsystemId provided as a string anymore (only as a number) and returns a 400 error message. While the update of the specification requires now to pass this property as a number, a string value is now still accepted for backward compatibility reason, as long as the string converts into a non zero number [ISAAC-S-602]
REST API PUT/POST /api/v1/variables endpoints require subsystemId as a mandatory field, whereas only subsystemExternalId field is specified to be mandatory to identify the Subsystem [ISAAC-S-620]

Active Endpoints Deprecation Notices

POST /api/v1/notifications



Removal Scheduled



Protected

Deprecation Date

October 15th, 2026

Removal Date

March 31st, 2027

Reason

This endpoint was implemented as part of the regular CRUD operations for Notifications, however only internal services are creating notifications. External Notifications creation is not supported as part of the current implementation and its usage results in unexpected behavior.

Replaced by

None

PUT /api/v1/license/firstRun



Removal Scheduled



Protected

Deprecation Date

May 15th, 2025

Removal Date

March 31st, 2027

Reason

This endpoint has been superseded by POST /api/v1/settings/firstRun

Replaced by

POST /api/v1/settings/firstRun

PUT /api/v1/logs/tags



Removal Scheduled



Protected

Deprecation Date

February 13th, 20225

Removal Date

March 31st, 2027

Reason

This endpoint was used for the rescan of the tag list, which has been made redundant by an internal tag list update.

Replaced by

None

POST /api/v1/router



Removal Scheduled



Public

Deprecation Date

August 8th, 2024

Removal Date

March 31st, 2027

Reason

This endpoint was used to update a variable value and has been superseded by POST /api/v1/variables/:id/value

Replaced by

POST /api/v1/variables/:id/value

Recently Removed Endpoints

DELETE /api/v1/subsystems/:id/compositions/:compositionId



Removed



Public

Deprecation Date

May 21st, 2024

Removal Date

October 30th, 2026

Affected Version

2.7.0+

Reason

This endpoint was originally the way for subsystems to delete compositions but has been superseded by DELETE /api/v1/compositions/:compositionId. The endpoint implementation was also not complying its specifications resulting in the deletion of Playables, not Compositions.

Replaced by

DELETE /api/v1/compositions/:compositionId

POST /api/v1/subsystems/:id/compositions



Removed



Public

Deprecation Date

May 21st, 2024

Removal Date

October 30th, 2026

Affected Version

2.7.0+

Reason

This endpoint was originally the way for subsystems to create compositions but has been superseded by POST /api/v1/compositions. The endpoint implementation was also not complying its specifications resulting in the creation of a Playable, not a Composition.

Replaced by

POST /api/v1/compositions

GET /api/v1/subsystems/:id/compositions



Removed



Public

Deprecation Date

May 21st, 2024

Removal Date

October 30th, 2026

Affected Version

2.7.0+

Reason

This endpoint was originally the way for subsystems to fetch compositions but has been superseded by GET /api/v1/compositions. The endpoint implementation was also not complying its specifications resulting in the return of Playables, not Compositions.

Replaced by

GET /api/v1/compositions

PUT /api/v1/subsystems/:id/compositions/:compositionId



Removed



Public

Deprecation Date

May 21st, 2024

Removal Date

October 30th, 2026

Affected Version

2.7.0+

Reason

This endpoint was originally the way for subsystems to update compositions but has been superseded by PUT /api/v1/compositions/:compositionId. The endpoint implementation was also not complying its specifications resulting in the update of Playables, not Compositions.

Replaced by

PUT /api/v1/compositions/:compositionId

API Life Cycle Policy

To ensure ISAAC platform stability while continuing to evolve our product, we manage API changes according to the following life cycle:



Active

Fully supported and recommended for use.



Deprecated

The endpoint remains functional but should no longer be used for new integrations. Existing integrations should consider a refactor to not use this endpoint, either using its replacement or deprecate the associated feature.



Removal Scheduled

The endpoint will be removed on the announced date. In general, this status goes along side with the Deprecated status, and is valid with the removal date is indicated.



Removed

The endpoint is no longer available.

Deprecation Notice Period

Minimum 6 months before removal.

Notification Channels

Product release notes
Email notifications to registered API consumers
API documentation updates



Public

The endpoint is available for subsystem integration. Included in the base license.



Protected

The endpoint requires an extended license to be able to use it. Not included in the base license.



Private

The endpoint is not available outside internal use. Although generally not part of the public documentation, it must not be used by third party.

FAQ

What does "deprecated" mean?



A deprecated endpoint continues to function but should no longer be used for new development or updates of existing development. It may be removed in a future release.

Will existing integration stop working immediately?



No. Existing integration will continue to function until the announced removal date.

How much notice will be provided before removal?



Unless a critical security issue requires immediate action, at least 6 months’ notice will be provided before endpoint removal.

How can I receive notifications?



When you are registered as Integrator Partner, you’ll receive deprecation notices automatically.

API Changelog

Learn about new features, updates, improvements, and bug fixes to the ISAAC API.

Active Endpoints Deprecation Notices

Recently Removed Endpoints

API Life Cycle Policy

FAQ

What does "deprecated" mean?



Will existing integration stop working immediately?



How much notice will be provided before removal?



How can I receive notifications?



Workspace

Platform

Ecosystem

Resources

ISAAC is developed by

Contact

Main Office

Showroom

Privacy Policy

ISAAC and the ISAAC “3 layer” logo and design are registered trademarks of Smart Monkeys, Inc. All other marks and names mentioned herein may be trademarks of their respective companies.
‍
© Smart Monkeys, inc. All right reserved.

API Changelog

Learn about new features, updates, improvements, and bug fixes to the ISAAC API.

Active Endpoints Deprecation Notices

Recently Removed Endpoints

API Life Cycle Policy

FAQ

What does "deprecated" mean?



Will existing integration stop working immediately?



How much notice will be provided before removal?



How can I receive notifications?



Workspace

Platform

Ecosystem

Resources

ISAAC is developed by

Contact

Main Office

Showroom

Privacy Policy

ISAAC and the ISAAC “3 layer” logo and design are registered trademarks of Smart Monkeys, Inc. All other marks and names mentioned herein may be trademarks of their respective companies.‍© Smart Monkeys, inc. All right reserved.

ISAAC and the ISAAC “3 layer” logo and design are registered trademarks of Smart Monkeys, Inc. All other marks and names mentioned herein may be trademarks of their respective companies.
‍
© Smart Monkeys, inc. All right reserved.