Generate an API Key

Cloudcraft offers a developer API that provides programmatic access and remote rendering of your architecture diagrams. The API also provides fully automated visualization of AWS and Azure accounts that are linked with your Cloudcraft account, either as ready to use images or as JSON data.

Authentication is required to use this API. This guide describes how to create an API key through the web interface.

The ability to use Cloudcraft's developer API is only available to Pro subscribers. Check out Cloudcraft's pricing page for more information.

Prerequisites

This guide assumes that you have:

Create an API key

To create an API key for automation, navigate to User > API keys and click Create API key.

Screenshot of Cloudcraft's user interface for managing API keys with a focus on the 'Create API Key' button.

You’ll want to give the API key a name that describes what it’s for, for example, “Automation Key,” and define the permissions you want to grant to the key. You may also share the key with a team.

Screenshot of Cloudcraft's API key creation interface with fields for naming and setting permissions.

When you’re done, click Save key and a new API key will be created. Make sure to write down the key in a secure location so you can use it later.

If you have any questions or issues with this process, contact Cloudcraft’s support team.