Updates

Welcome to our Updates page, where you can find news and information about our latest API releases.

September 26, 2022

Version: 2022-09-26

This release introduces two new endpoints for teams and runbooks respectively, as well as some other minor improvements and fixes.

Major changes

New Team endpoint

We've added a new Team endpoint:

  • Delete a Centralized Team - DELETE /core/teams/{id}

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 Runbook endpoint

We've added a new Runbook endpoint:

  • Get roles for a runbook - GET /core/runbooks/{id}/roles

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.

Other minor changes

  • We’ve added the ability to read and update users who are assigned to, and are recipients of communications from, a task. This applies to List Tasks in a Runbook, Get a Task, Create a new Task and Update a Task endpoints. Note: You need to at least have Cutover Core version 3.68 for this endpoint to work.
  • We’ve added query parameters to the List Users endpoint so you can filter returned results. Note: You need to at least have Cutover Core version 3.69 for these to be available:

    - page[number](pagination)
    - query (approximate string matching by team name (also known as a ‘fuzzy’ search))
    - role_type_id
    - workspace_id
  • We’ve added event and resource_type query parameters to the List Action Logs endpoint to help improve the filtering of your results. Note: You need to at least have Cutover Core version 3.68 for these to be available.
  • When no bearer token is passed for authentication, we’ve corrected the error that gets returned; it is now 401 Unauthorized instead of500 Internal Server Error.
  • We’ve now removed support for Cutover Core version 3.63.0.

September 8, 2022

Version: 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.

Major changes

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.

Enhancement to Get roles for a user endpoint

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.

Other minor changes

  • We've improved our User endpoint's path parameters documentation to make it clear when a user's email can be used instead of their ID. Note: You need to at least have Cutover Core version 3.67 to benefit from this improvement.

August 24, 2022

Version: 2022-08-24

This release introduces a new endpoint for retrieving information on team roles, as well as some other minor improvements and fixes.

Major changes

New Team endpoint

We've added a new Team endpoint:

  • Get roles for a team - GET /core/teams/{id}/roles

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.

Other minor changes 

  • We’ve renamed Team/s to Centralized Team/s where relevant in our endpoint documentation.
  • We’ve improved our JSON examples in our endpoint documentation for Create a new Centralized Team and Update a Centralized Team.
  • We’ve removed support for Cutover Core version 3.61.

August 2, 2022

Version: 2022-08-02

This release introduces a new endpoint for merging runbooks, as well as several other minor improvements and fixes.

Major changes

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.

Other minor changes 

  • We have added three query parameters to List Teams to improve the ability to filter returned results. Note: You need to at least have Cutover Core version 3.65 for these parameters to work:

    - page[number] (pagination)
    - query (approximate string matching by team name (also known as a ‘fuzzy’ search))
    - workspace_id
  • We have made general fixes and improvements to the Role resource. We have also added request examples to endpoint documentation that uses the resource. Note: You need to at least have Cutover Core version 3.65 to benefit from these fixes and improvements.
  • We have added the key attribute to the RoleType resource. For example, this means you can read and pass the key string workspace-stakeholder as opposed to having to look up the RoleType's id.
  • We have implemented a fix for missing custom_field_values for returned Task resources.
  • We have implemented a fix to hide a returned Runbook resource’s relationships attribute source_runbook when the attribute has not previously been set.
  • We have improved the detail given in the 400 Bad Request error, which now makes it clearer when path parameters have not been specified. The lack of details previously given was liable to lead to the incorrect assumption that the error was in the JSON payload.

July 13, 2022

Version: 2022-07-13

This release adds support for Cutover Core version 3.64, adding communication- and login-related attributes to the user resource.

Major changes

New User attributes

We have added some new attributes to the User resource to increase its comprehensiveness.

  • You can now create, update and read a user’s email and SMS acceptance settings with accept_email and accept_sms.
  • You can now read login-related activity and metrics via these meta attributes:

    - last_activity_at
    - last_sign_in_at
    - invitation_accepted_at
    - invitation_sent_at
    - sign_in_count

June 22, 2022

Version: 2022-06-22

This release adds support for Cutover Core version 3.63, introducing two new endpoints for folders.

Major changes

New Folder endpoints

We have added two new Folder 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.

Other minor changes

  • We have added a runbook’s description to the List Runbooks response. Even if a runbook has not been given a description, a blank string is now returned.
  • We have added source_runbook_id as a query parameter to List Tasks in a Runbook, letting you filter your task results by it.
  • We have added the ability to pass users/{email} as well as users/{id} on all endpoints using the user path. For example, you can now call GET /core/users/user%40example%2Ecom (note that periods must be escaped).

June 3, 2022

Version: 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.

Major changes

New ActionLog endpoint

We have added a new ActionLog 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 Custom Field endpoints

We have added five new Custom Field 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 Task endpoints:

  • Skip a Task - GET /core/runbooks/{runbook_id}/tasks/{id}/skip
  • Delete a Task - DELETE /core/runbooks/{runbook_id}/tasks/{id}

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.

Other minor changes

  • We have added the forecast query parameter to the List Streams in a Runbook endpoint. This means the endpoint now has two modes - a conventional mode which only returns attributes related to the streams, and a ‘forecast’ mode which returns additional start and end time information that has been calculated from the stream’s tasks.

May 16, 2022

Version: 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.

Major changes

New Role Type 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 User App Token endpoints

We have added three new User App Token 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 clicking ‘API Documentation: Log in' in the ‘My Details’ panel. 

This takes you to the ‘Overview’ page, at the top of which sits the ‘Changelog’.

Other minor changes

  • We have added the ability to pass custom_field_values to the Start a Task and Finish a Task endpoints.
  • We have added example JSON requests to the documentation for Create a New Task and Create a New User. Previously these areas were blank.
  • We’ve ensured the last page link is always shown in pagination. Previously it wasn’t showing when you were on the last page itself.

Cookie consent

By clicking “Accept”, you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. View our Privacy Policy for more information.