Welcome to our Updates page, where you can find news and information about our latest API and Integrations releases.
2024.14. Integrations Updates
This Integrations update includes changes made to Polling and Data Sources.
You can now set a maximum retries amount for integrations that require polling. The default value for new and existing integrations are 120 retries and this can be increased or decreased as required. You should review any polling integrations (through Custom Integration) to ensure this number suits your needs.
The default polling interval value has been updated to 30 seconds for all new integrations.
Please see our Polling section for more information about these changes.
You can now pull new fields and attributes from the data source by using the Refresh option which can be found in the three dots menu. Here you can also archive a data source too. Refreshing a datasource will require users to input a new search value before new attributes can be retrieved.
Previously data sources only supported non-nested JSON structures. You can now drill down into nested JSON for data sources, allowing you to be more granular when adding this information into the platform.
Release date: 2024-10-23
This release introduces new Folder and Runbook endpoints and a List Runbooks enhancement
In this update, we've made the following changes:
Enhancements to the `List Runbooks` endpoint for editing runbooks
We’ve added an is_editable attribute to the `Runbook` resource. This means that the runbook can be marked as editable/uneditable during certain processes such as the Task CSV Import.
Note: You need to have at least Cutover Core version 2024.13.0 to see the above mentioned change.
New Runbook endpoint added
This endpoint retrieves all of the roles for a specific runbook. You can use the available query parameters to filter the results.
Note: You need to have at least Cutover Core version 2024.14.0 to see the above mentioned change.
New Folder endpoints added
This endpoint replaces all roles on the folder. Note: You will need to have at least Cutover Core version 2024.14.0 to use this endpoint.
This endpoint updates a specific folder in a specific workspace. Note: You will need to have at least Cutover Core version 2024.14.0 to use this endpoint.
The List, Get, Create and Update Integration action endpoints now have updated schemas.
To make it easier when searching we’ve set the default sort order for ‘List Users’ to be core_users.email.
We’ve also fixed the List Tasks in a Runbook query parameter runbook_team_id.
Release date: 2024-09-05
This release introduces new integrations endpoints
New endpoints
In this update, we’ve added five new `Integrations` endpoints:
Note: You need to have at least Cutover Core version 2024.12.0 to use these endpoints.
These endpoints will allow you to manage your integrations by giving you the ability to create new, update, archive, retrieve and get a list of integration actions in your instance.
Other minor changes
We’ve added an `archived` query parameter to the List Runbooks endpoint to help improve the filtering of your results. It can filter on true or false.
Release date: 2024-08-07
This release introduces new Integrations endpoints
New endpoints
In this update, we’ve added five new `Integrations` endpoints:
Note: You need to have at least Cutover Core version 2024.11.0 to use this endpoint.
These endpoints will allow you to manage your integration actions by giving you the ability to create new, update, archive, retrieve and get a list of integration actions in your instance.
We’ve also made some documentation improvements to our `Get a Runbook` query parameter custom field values.
Release date: 2024-07-24
This release introduces new Task endpoints and the ability to Star comments.
New 'Task' endpoints:
In this update, we’ve added three new `Task` endpoints:
Note: You need to have at least Cutover Core version 2024.10.0 to use this endpoint.
Note: You need to have at least Cutover Core version 2024.9.0 to use the above two endpoints.These endpoints will allow you to manage your integrations by giving you the ability to trigger, pause and check the status.
We’ve added a featured attribute to the Comments resources. This gives the ability to Star comments.
We’ve also fixed an issue with filtering the List Comments in a runbook endpoint.
Note: You need to have at least Cutover Core version 2024.8.0 to see the above mentioned change.
Release date: 2024-04-03
This release introduces a new 'Runbook' endpoint.
In this update, we have made the following changes:
New `Runbook` endpoint
We’ve added a new `Runbook` endpoint - Replace roles for a runbook - POST /core/runbooks/{id}/roles
The endpoint replaces all roles on the runbook. When making updates to an existing runbook, use the "Get roles for a runbook" endpoint to retrieve the current role data.
Note: You need to have at least Cutover Core version 2024.5.0 to use this endpoint.
Release date: 2024-02-06
This update includes updates to the endpoint descriptions, a new attribute to the Runbook resource and a source_runbook attribute.
In this update, we have made the following changes:
Note: You need to have at least Cutover Core version 2024.2.0 to see this attribute.
Note: This is only required on the Get a Runbook endpoint.
Release date: 2023-11-20
This release introduces three new endpoints and an enhancement to List Runbooks.
New 'Runbook' endpoints
In this update, we’ve added three new endpoints:
These endpoints will allow you to manage your runbooks by giving you the ability to pause, resume and cancel.
Note: You need to have at least Cutover Core version 3.84 to use these endpoints.
Enhancement to the 'List Runbook(s)' endpoint
We’ve added the following attributes to the Runbook resource to help with sorting the List Runbooks response by when the runbooks were last touched_at.
Note: You need to at least have Cutover Core version 3.83 to use this attribute.
Release date: 2023-11-07
This release introduces new Stream endpoints.
New 'Stream' endpoints
In this update, we’ve added three new 'Stream' endpoints:
Note: You need to have at least Cutover Core version 3.84 to use these endpoints.
Release date: 2023-10-03
This release introduces a new query parameter to Get Roles for a User API.
Enhancements to the 'Get Roles for a User' endpoint
We’ve added a 'resource_type' query parameter to the Get Roles for a User endpoint to help improve the filtering of your results. It can filter on global, folder, workspace, runbook, stream or user.
Note: You need to at least have Cutover Core version 3.82 to use this query parameter.
Release date: 2023-08-22
This release introduces enhancements to merge runbooks API and the ability to create linked runbooks.
New options added to the 'Merge Runbook(s)' endpoint
We’ve added a new 'Merge Runbook(s)' endpoint:
Added new Linked Runbooks functionality
Enhancements to the Get a Runbook resource for Snippets functionality
New Get a User query parameter
Note: You will need to at least have Cutover Core version 3.82 to use all of these new features
Release date: 2023-07-25
This release introduces enhancements to the List Tasks in a Runbook response, to the runbook resource and to the Get a Runbook endpoint.
Enhancements to the 'List Tasks in a Runbook' response
We’ve made two enhancements to the List Tasks in a Runbook response:
Note: You need to at least have Cutover Core version 3.81 to benefit from both of these improvements.
Enhancements to the 'Runbook' resource
We’ve made two enhancements to the source:
Note: You need to at least have Cutover Core version 3.81 to benefit from both of these improvements.
New 'Get a Runbook' query parameter
In light of the addition of the external_id attribute to the Runbook resource, a new query parameter has been added to the Get a Runbook endpoint:
It can filter on either a normal runbook id or on the external_id.
Note: You need to at least have Cutover Core version 3.81 to use this query parameter.
Release date: 2023-05-22
This release introduces two new query parameters for listing action logs, plus a couple of other minor improvements and fixes.
New 'ActionLog' query parameters
We've added two new query parameters to the List Action Logs endpoint:
These new query parameters allow you to filter by actions performed after and before a given date and time.
Note: You need to at least have Cutover Core version 3.79 to use these query parameters.
Release date: 2023-05-04
This release introduces three new endpoints for runbook teams, plus some other enhancements for template workflows.
New 'RunbookTeam' endpoints
We've added three new 'RunbookTeam' endpoints:
These endpoints give you greater control and more efficient management over your runbook teams. You can create new runbook teams in a specified runbook, as well as delete them from a specified runbook. You can also unlink a runbook team from its centralized team, which copies its list of users over to a specified runbook which can then be customized.
Enhancement to the resource for template workflows
We’ve added the following attributes to the Runbook resource to help with managing and tracking template workflows. They can be used to retrieve the status of templates, as well as provide other key information, all of which can be important for reporting purposes.
Release date: 2023-03-01
This release introduces two enhancements to the task resource.
Enhancements to 'Task' resource
We’ve added the following in relation to the auto_finish attribute. Note: You need to at least have Cutover Core version 3.76 to benefit from these improvements:
- task.auto_finish_on_auto_finish_task_type: It can't be set on an Auto Finish task type.
- task.auto_finish_on_branching_task_type: It can't be set on a Branching task type.
- task.auto_finish_on_integration: It can't be set on an Integration task type.
- task.auto_finish_on_linked_task_type: It can't be set on a Linked to Runbook task type.
- task.auto_finish_on_required_custom_fields: It can't be set on tasks with required custom fields that display on the task's end.
- end.task.auto_finish_on_snippet_task_type: It can't be set on a Snippet task type.
- task.auto_finish_requires_end_fixed: It can't be set on tasks that have a fixed due date and time.
Release date: 2023-01-31
This release introduces three enhancements to the task resource, the List Folders endpoint and the stream resource respectively.
Enhancement to 'Task' resource
We’ve added an auto_finish attribute to the resource. This means you can read whether a task is set to automatically finish, as well as use the endpoints Create a New Task and Update a Task to apply automatic finishes to tasks. To clarify the working of the auto finish feature, a task will automatically finish once its specified duration has expired, provided all validation has passed beforehand. Note: You need to at least have Cutover Core version 3.76 to benefit from this improvement.
Enhancement to the 'List Folders' endpoint
We’ve added meta.permissions data to the Folder resource in the List Folders response, enabling you to read which folders you have the permission to create runbooks in. Note: You need to at least have Cutover Core version 3.76 to benefit from this improvement.
Enhancement to the 'Stream' resource
We’ve added parent data to the stream.relationships object so you can see which sub-streams belong to which parent stream.
Release date: 2023-01-11
This release introduces an enhancement to the folder resource.
Enhancement to 'Folder' resource
We’ve added parent data to the folder.relationships object so you can see which subfolders belong to which parent folder, create new subfolders, and update subfolders so they belong to different parent folders. Note: You need to at least have Cutover Core version 3.73 to benefit from this improvement.
Release date: 2022-12-06
This release introduces a new endpoint for runbook teams, plus an enhancement to task endpoints.
Firstly, a notice: A fix has been implemented in Cutover Core version 3.73 meaning that Update a Runbook works as expected. If you have an earlier Cutover Core version, the call incorrectly results in creating a new or empty runbook version. To avoid this, upgrade to 3.73.
New 'RunbookTeam' endpoint
We've added a new 'RunbookTeam' endpoint:
This endpoint lets you retrieve all runbook teams from the current version of a specified runbook.
Note: You need to at least have Cutover Core version 3.73 to use this endpoint.
For endpoints, we've added the ability to read and update runbook teams who are assigned to, and are recipients of communications from, a task. Note: You need to at least have Cutover Core version 3.73 to benefit from this improvement.
Release date: 2022-09-26
This release introduces two new endpoints for teams and runbooks respectively, as well as some other minor improvements and fixes.
New 'Teams' endpoint
We've added a new 'Teams' endpoint:
This endpoint lets you delete a centralized team that you no longer require. It will temporarily mark the team as archived before copying all deleted roles to linked runbook teams, and then fully deleting the team.
New 'Roles' endpoint
We've added a new 'Roles' endpoint:
This endpoint lets you retrieve the roles (for example Runbook Admin, Stream Editor and Runbook Member) connected to a specified runbook.
Note: You need to at least have Cutover Core version 3.65 for this endpoint to work.
Release date: 2022-09-08
This release introduces a couple of enhancements to a task and user endpoint respectively, as well as some other minor improvements and fixes.
Enhancement to 'List Tasks in a Runbook' endpoint
When you request a source_runbook in the List Tasks in a Runbook endpoint via the source_runbook_id query parameter, the response now includes the full runbook object in the included array.
Note: You need at least Cutover Core version 3.67 to benefit from this enhancement.
We’ve enhanced the included object in the Get roles for a user endpoint’s response to include all possible resources that the relationships object references within it.
Release date: 2022-08-24
This release introduces a new endpoint for retrieving information on team roles, as well as some other minor improvements and fixes.
New 'Roles' endpoint
We've added a new endpoint:
This endpoint lets you retrieve the roles for a team member by their ID or email.
Note: You need to at least have Cutover Core version 3.65 for this endpoint to work.
Release date: 2022-08-02
This release introduces a new endpoint for merging runbooks, as well as several other minor improvements and fixes.
New 'Runbook' endpoint
We have added a new 'Runbook' endpoint:
This endpoint lets you merge single or multiple runbooks into the runbook that you specify in the path parameter.
Note: You need to at least have Cutover Core version 3.65 for this endpoint to work.
Release date: 2022-07-13
This release adds support for Cutover Core version 3.64, adding communication- and login-related attributes to the user resource.
New attributes
We have added some new attributes to the 'User' resource to increase its comprehensiveness.
Release date: 2022-06-22
This release adds support for Cutover Core version 3.63, introducing two new endpoints for folders.
New 'Folder' endpoints
We have added two new endpoints:
These endpoints give you greater control and management over your folders in a specified workspace. You can create new folders and you can update the name and description of existing ones.
Release date: 2022-06-03
This release adds support for Cutover Core versions 3.61 and 3.62, introducing nine new endpoints covering action logs, custom fields, runbooks and tasks.
New 'ListActionLogs' endpoint
We have added a new endpoint:
Provided you are either a Global User Admin or a Global Stakeholder, this lets you retrieve all of the action logs for your instance. Action logs provide you with a description of the action, any related changes because of the action, the author of the action, and the resource involved in the action. This information can be used for auditing purposes.
New 'CustomFields' endpoints
We have added five new endpoints:
These endpoints give you the ability to manage your custom fields. List Custom Fields lets you retrieve all of the custom fields in your instance, whereas Get a Custom Field lets you retrieve a specific custom field by its ID. Delete a Custom Field will in fact archive (as opposed to hard deleting) a custom field you no longer wish to make use of, meaning it is still possible to read it at a later date.
New 'Runbook' endpoint
We have added a new 'Runbook' endpoint:
This endpoint lets you archive a runbook, removing its visibility and access from your instance once it is no longer required or has served its purpose.
New 'Task' endpoints
We have added two new endpoints:
These endpoints add to the existing task endpoints, furthering your ability to control and manage tasks by being able to skip or delete a specific one in a runbook.
Release date: 2022-05-16
This release adds support for Cutover Core version 3.60, introducing eight new endpoints covering role types, user app tokens, and workspaces.
New 'RoleType' endpoint
We have added a new 'Role Type' endpoint:
This lets you retrieve all of the role types that are currently enabled in your instance, providing an ID and a description of the role type. You can then use role type IDs when creating, updating or simply just reading roles.
New 'UserApp' endpoints
We have added three new 'UserApp' endpoints:
These endpoints provide you with the ability to control and manage API access to your Cutover instance. List User App Tokens lets you retrieve all of the user app tokens belonging to a specific user. Create a New User App Token lets you create new tokens per user, and Delete a User App Token lets you delete tokens per user (effectively meaning you can revoke a user’s API access).
New 'Workspace' endpoints
We have added four new 'Workspace' endpoints:
These endpoints provide you with the ability to manage your workspaces. Update a Workspace lets you update the name and description of a specified workspace, Archive a Workspace lets you remove visibility and access to a specified workspace once it is no longer required or has served its purpose, while Unarchive a Workspace lets you restore it if it is needed again.
'Changelog' added to your API Portal
We have added a 'Changelog' section to your instance’s API Portal, providing you with a list of all the changes for every API version that we release.
The section is accessed by clicking on My Profile in the bottom-left corner of the app and, under where it says 'View API endpoint documentation with credentials:' in the My Details panel, click either On the Developer Portal or On your API instance.
This takes you to the ‘Overview’ page, at the top of which sits the ‘Changelog’.