Skip to main content
You must have a Cloudways account with API access enabled. API access is available on all plans.

​
Generate your API key

An API key authenticates your integration with the Cloudways Platform API.

1

Sign in to Cloudways

Sign in to your Cloudways account.

  • Click your profile icon in the top-right corner and select Account from the dropdown.
2

Enable and copy your API key

Navigate to the API section in your account settings.

  • Direct link: platform.cloudways.com/api
  • If API access is not yet enabled, toggle it on.
  • Your API key will be displayed on this page.
  • Copy the API key and store it securely for use later.
  • Note: if you click Regenerate Key, your previous key will be revoked immediately.

​
Find your account email

Your account email is the email address you use to sign in to Cloudways.

  • This is the same email shown on the Account > Profile page.
  • Note: if you change your Cloudways account email, your API key will also be updated and you will need to reconfigure the integration.

​
Linking the Account from the Hub

1

Navigate to the Hub

Use one of the three Linking Account Methods to access the Hub.
2

Fill out the fields

Fill out the following fields using details from your provider:
  • Email
  • API Key
3

Connect

  • Click Connect
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup

If the account linking is successful, you will see the newly linked account in your Accounts page.