REST API

Introduction to the Tuono API

Introduction

Does Tuono have an API? Of course we do! What kind of automation platform wouldn't have an API?

The Tuono API is the same API used by our SaaS offering. Anything that you can do in our GUI, you can do programmatically via the API. Not only can you write Infrastructure as Code, but you can also go full "meta" and write code that writes Infrastructure as Code.

Suggested Workflow

Just because you can write code that writes Infrastructure as Code doesn't mean you should. In fact, we recommend you don't. Crafting Blueprints and Environments is way easier via the GUI. And didn't you join Tuono to get away from writing massive amounts of code?

But that doesn't necessarily mean you shouldn't write any code. Integrating your infrastructure management system with your CI/CD pipelines can enable all sorts of development and business efficiencies. And we love efficiency!

The most efficient way to use Tuono with your automation and CI/CD systems is to take a hybrid approach.

Use the GUI for:

• Managing your users

• Managing your secrets

• Creating and editing Blueprints

• Creating and editing Environments

Use the API for:

• Applying Environments to your cloud vendors

• Destroying Environments in your cloud vendors

• Monitoring Job status as part of a CI/CD pipeline

Of course, you do not need to listen to us. You can use the API to do anything you can do in the GUI.

Overview

The Tuono API is a pretty standard RESTful-like HTTP API. You perform GET, PUT, POST, and DELETE operations models hosted by our web service. Almost all operations require a JWT in the Authorization header of the call. Parameters are passed to the web service via JSON in the body of the request. Results are returned as JSON structures in the body of the response.

Don't worry if you're not sure what most of the previous paragraph is about, we'll walk you through a few interesting operations in the rest of this guide. It won't be comprehensive, but it'll be enough to get you started and useful. You can then use the REST API Reference to take you the rest of the way to your goal. You can find a link to the REST API Reference at the bottom of the navigation menu to your left. Or click here: https://portal.tuono.io/api/v1/ui/