Turbonomic REST API Swagger documentation

You can try out different REST methods in the Swagger documentation to see typical response DTOs.

To access the Turbonomic Swagger documentation, navigate to:

https://<Your_Turbonomic_URL>/apidoc

This documentation uses a standard Swagger-UI application that delivers documentation for all the methods on the different endpoints in the API. This documentation includes a description of the call, a list of parameters to pass, and descriptions of the JSON payloads you POST or PUSH, as well as the payloads you get in the response. If you view the MODEL of a JSON payload, you can navigate the JSON structure to see descriptions of the different object fields.

To access the API, the Swagger-UI requires authentication. If you have already logged into Turbonomic, your browser session should have a current authentication cookie. The Swagger-UI uses this same cookie for its API authentication.

For each method, the Swagger doc includes a Try it out feature where you can set up a call through the Swagger-UI, and then execute it. This generates the following information as a response:

• A curl request for your call

  The curl commands generated by Swagger may need some modification for use in your environment (for example, escaping quotes or adding the -k modifier in order to use HTTP URLs).

• A standard HTTP request for your call

• The server response code

• The response body – The JSON data that the API call returns

• Response headers