In this KB, you will learn how to:
- Launch API
- Generate an API Key
- Access API Documentation and Playground
- Use the API Playground to become familiar with the 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 leverage 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.
Let’s get started:
Step 1: Launch API
Log in to your console and click on API as shown in the screenshot below.
Step 2: Generate an API Key
In 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 API Key”.
Step 3: Access API Documentation and Playground
Once the key is generated, click on it to copy and proceed to the next step.
API Secret Key: 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 future.
API Documentation: 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.
API Playground: 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.
Step 4: Use the API Playground to become familiar with the API
In this step, click on “Authorize” button on the top right 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 end-point calls. 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 all for now!