Cutover API Overview
Our API gives you programmatic access to Cutover’s platform and resources such as your workspaces, runbooks, tasks, teams and users. You can connect other systems to Cutover and build sophisticated inbound automated processes, extending your Cutover instance’s functionality and capabilities.
Cutover’s API is RESTful. This means common HTTP methods (GET, PATCH, POST and DELETE) are used to access and manipulate resources via predictable resource-oriented URLs. For instance, retrieving a list of runbooks from a workspace is done via
GET https://api.[cutover_instance_name].cutover.net/core/runbooks
Our API accepts and returns JSON in the HTTP body, and it returns standard HTTP response codes (such as 200 OK or 401 Unauthorized, for example).
To get started with our API, you will need to:
1. Ensure you have the ‘Developer’ role assigned
2. Know your base URL
3. Create a user app token with which to authenticate to the API
4. Understand how to make an inbound REST API call
Try function:
Once you've followed the steps above, you'll then be able to use the TRY functionality to test API calls directly from your browser.
1. Select an operation from the left-hand sidebar on the Endpoints page, (for example, List Runbooks or Get a Task). The right-hand panel will display the documentation for the selected endpoint. In the Request/Response section, you’ll typically see a Try button.
.jpg)
2. Enter your Base URL (your Cutover instance URL) and a User App Token, which can be found in Cutover under Settings → User App Tokens.
3. Provide any required IDs (such as runbook_id) and, for POST or PATCH requests, update the JSON request body as needed.
4. Click Execute to run the request and view live results, including the response body, status code, and a copyable cURL command.
Important: These are live API calls. We recommend using a sandbox environment when testing DELETE or PATCH requests, and ensuring your token has the appropriate permissions for the action.
Contact your Customer Success Manager (CSM) if you need further guidance on our API.
