Search The Hostwinds Guides Knowledge Base

Hostwinds Cloud API Overview

Share This Article

When you purchase a VPS or Cloud server with Hostwinds, you get unrivaled control over your new virtual server. You are granted super user access (root for Linux, administrator for Windows), but we also have a fully developed Cloud Control Portal where you can control a wide variety of features: SSH keys, snapshots, volume management, operating systems of choice, ISOs, firewall profiles, adding SSL certificates, and overall server administration tasks.

Hostwinds clients who wish to have even more options to access and control cloud servers have a fully functioning API. This allows you to develop a unique user interface and is something you can completely customize. This allows you to create your own designs, branding, or functionality depending on your needs.

Where Do I Access the Hostwinds Cloud API?

The Hostwinds Cloud API can be found in your Cloud Control Portal.

Step 1: From your Client Area, select the Cloud Control dropdown, and click on Cloud Portal.

The Cloud Portal link in the Client Area

Step 2: From your Cloud Control Portal, select the Account dropdown, and click on API Keys

API Key Link

Step 3: On the API Key page, click on the API Documentation button

API Documentation

You can now review your entire API for managing any Cloud VPS features. For your convenience, here is a Direct Link to Hostwinds Cloud API.

What Is an API Key?

In order to utilize the Hostwinds Cloud API, you first need to ensure your account can connect to your Cloud Server Portal. To do this, create an API Key which then can be used in your API code. This Key is unique to each client, and will be generated using a random string of characters .

Create an API key in your Cloud Portal

Step 1: From your Client Area, select the Cloud Control dropdown, and click on Cloud Portal.

The Cloud Portal link in the Client Area

Step 2: From your Cloud Control Portal, select the Account dropdown, and click on API Keys

API Keys Link

Step 3: Click the green Create API Key button, type in a description or name for the API Key, and select Create Key. OPTIONAL: You may also choose to set an expiration date on the Key if you so choose, where the key will no longer be valid after a certain time.

Create API Key

You should receive a success message if the new API key was successfully created, such as the following:

The success message for creating an API key

You can also check if the API key has been added to your list of API keys on the API key page:

API Keys

More Information