API Reference

Welcome to the Turbonomic REST API Guide. This guide will help you to use the Turbonomic REST API as you script interactions with the Turbonomic software and develop integrations between Turbonomic and other software applications.

The REST API exposes Turbonomic data and processing to remote access via HTTP GET, POST, PUSH, and DELETE methods.

The Turbonomic user interface is a client to this API, and every feature exposed in the user interface is the product of API calls. To understand the API, you should have a working knowledge of the Turbonomic user interface, the features it exposes, the data it uses, and the use cases that it supports. In most cases, if you want to script some Turbonomic behavior, you should be able to execute most of that behavior via the user interface. Stepping through these use cases in that context will help you plan and implement your scripts.

To get the most out of the REST API, you should understand how Turbonomic organizes its underlying data, and how the various REST resources map to that organization. This introductory section includes discussions of the data that underlies:

  • Markets and how they represent your environment (see Markets)

  • Plans and an overview of how to work with them (see Plans)

  • Workload placement policies and how they are represented (see Workload Placement Policies)

  • Reservations for deployment, and how to set them up (see Reservations)

Note:

This guide is not a comprehensive reference to every possible setting and data payload in the REST API. Many endpoint descriptions include samples of API data objects, but they cannot document every possible combination of inputs. For a complete reference to the API, use this guide in conjunction with the Turbonomic REST Swagger-UI documentation. For more information, see Turbonomic REST API Swagger Documentation.