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.

Cutover API
API Use Cases
Secondary Repository

Secondary Repository

Last Updated
September 27, 2023

Cutover is proud of its service availability scores for customers, but we understand there may well be a policy or audit requirement where runbook data must also be stored within a customers own infrastructure.


The Cutover API provides a great way of extracting the data in your runbooks, custom fields and workspaces etc. The API calls you make can be used to store the data in a data lake or a reporting tool of your choice.

Key Benefits
Satisfies any requirement to have copies of runbooks within a client infrastructure
Auditing - ability to formulate a history of activities that has occurred in Cutover


This recipe outlines how to use the Cutover API to build a Secondary Repository. Let’s get started:

1. Execute the List Workspaces API to retrieve the ID of the workspace where the runbooks you are looking to extract are located. 

2. If the runbooks are located in folders, use the workspace ID from step 1, and execute the List Folders API to find the ID of the folder.

3. To GET a list of all the runbook IDs, execute the List Runbooks API. The API response can be filtered down by runbooks located in a particular workspace or folder using the IDs retrieved from step 1 and step 2. This requires the Folder ID and the Runbook ID to be added to the query string parameters.

4. For each runbook ID returned in step 3, execute the List Tasks in a Runbook API. Each task will contain all of its key attributes, some of the values will contain IDs to other data objects, to retrieve the names run the following API calls.

5. Run the List Task Types.

6. Run the List Runbook Teams in a Runbook using the runbook ID in step 4.

7. Run the List Streams in a Runbook using the runbook ID in step 4.

8. You can look up the names of the data objects in steps 5, 6 and 7 for each task extracted in step 4. 

Available endpoints
List Runbooks

This endpoint retrieves runbook level information. You can use parameters to return all runbooks associated with a workspace, folder or even the stage the runbooks are at.

Get Roles for a Runbook

This endpoint retrieves all the users that are associated with a given runbook and retrieves the roles.

List Tasks in a Runbook

This endpoint breaks down each individual task associated with a runbook.

List Folders

This endpoint provides all the folders associated with a workspace.

List Streams in a Runbook

This endpoint provides all the streams associated with a runbook.

List Runbook Teams in a Runbook

This endpoint provides all the teams associated with a runbook.