Getting Started

The Integration API is created for companies, developers, or organizations that run SaaS platforms requiring programatic deployments of new workloads. It can also be used on CI/CD pipelines.

This guide will walk you through obtaining your API key from the KloudDeploy Web UI and cover the basic flow of deployment.

API Key

1. Login to the Web UI of KloudDeploy
2. Click on Settings on the left side bar
3. Click on API Keys
4. Scroll to Integration API Keys section
5. Click Create New Key button
6. Fill in a name to easily reference this key in the future
7. Copy the key as it will only be displayed once.

That's it! Now you can use this key to deploy new workloads programatically or use it for CI/CD.

Deployment Flow

1. Get LaunchPack ID with Get list of LaunchPacks or Search LaunchPack by name
2. Create a deployment with Create deployment
3. Confirm deployment with Execute deployment