How to Use the Cloudways API

Cloudways Platform API provides the power, flexibility, and ease of use of the Cloudways Platform in a simple to use API.

With Cloudways API, developers, e-commerce store owners, and development agencies can utilize the technology behind the Cloudways Platform and build their applications on top of it.

You can integrate server operations, perform application-related tasks, and automate different workflows of your servers.

Cloudways API is powerful yet intuitive and easy to use and allows you the power to do everything with it that you can on the Platform.

Table of Contents:

Log into the Cloudways Platform with your credentials and click on the bottom left menu icon and then click 'API Integration'.

On the next page, you will need to create an API Key. This API Key will be needed for you to authorize yourself to the API in order to use it. To do that, click on Generate Key.

Once the key is generated, click on it to copy and proceed to the next step.

You can also access API Documentation and API Playground right from here.

Once customers understand how to use the Cloudways API, it’s equally important to guide them on where they can access the API Documentation, explore the purpose of the API Playground, and learn how to use it to test requests safely before implementing them in real workflows.

If you ever wish to change your API Key, click on Regenerate Key. This will revoke your old Key, so please keep a note of your Key at a safe place to use it in the future.

For details of the API and each of its end-points, the API Documentation is the authoritative source. It covers detailed specifications and documentation of the Platform API.

The Cloudways API is organized into several categories, helping you automate different areas of your Cloudways platform. Below is a brief overview of the features shown in the API documentation menu:

Lists:

Provides endpoints to retrieve predefined values used across the API, such as cloud providers, regions, plans, and other selectable parameters.

Server:

Includes endpoints to create, manage, and control your servers. You can perform actions like launching a server, checking server details, and managing server operations.

Server Management:

Contains advanced controls for server-level operations, such as scaling resources, restarting services, monitoring usage, and managing settings.

Service:

Allows you to manage specific services running on your servers—such as Apache, Nginx, PHP-FPM, MySQL—by starting, stopping, and restarting them through API requests.

Application:

Covers all operations related to your applications. You can create applications, retrieve app details, manage settings, perform backups, and trigger deployment actions.

Authentication:

Provides endpoints for generating and validating your API access tokens. This is required before making authorized requests to the Cloudways API.

Projects:

Enables you to organize your servers and applications into projects. You can create, update, delete, and retrieve projects via API.

Git:

Contains endpoints for managing Git deployments, allowing you to link repositories, pull changes, and automate code updates on your applications.

CloudwaysBot:

Allows you to interact with CloudwaysBot settings using the API. This includes retrieving notifications, managing channels, and customizing alert preferences.

App Management:

Focuses on day-to-day app controls such as domain management, cron job management, SSL installation, and general application configurations.

Security:

Provides endpoints for whitelist/blacklist IP management and controlling access lists for enhanced server and application security.

Operation:

Includes system-level operational endpoints used for performing certain platform actions, retrieving logs, and triggering maintenance or utility tasks.

This is an online, in-browser playground for interacting with the API. This is by far the best way to become familiar with the API and test-friendly waters.

Please note that while we call it the Playground, any actions performed on the playground will be performed against your main account with which you will authenticate.

You will have to be careful which end-points you call on which of your servers. The safest path would be to use a test server under your account for this.

Refer to the following Step #4 to understand how to use the API Playground.

In this step, click on the Authorize button on the top right corner and enter your registered Cloudways account email ID and the API Key you copied in Step #3.

The API Playground will make it very easy for you to test out different API end-points and observe how they behave.

You will also find helpful examples of each API endpoint call. Once you have become familiar and comfortable with the API, you can dive deep into the API Documentation and begin coding up your programs to use the Platform API.

That’s it! We hope this article was helpful.

If you need assistance, feel free to:

We're here 24/7 to help you!