> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cloudways

> How to set up the Cloudways connector, plus the actions that are available.

![Cloudways](https://stackone-logos.com/api/cloudways/filled/svg)

Betav1.1.0[See changelog](https://docs.stackone.com/connectors/cloudways/changelog.md)

[82 actions](#actions) · 1 auth method

Infrastructure

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/cloudways/guides/connector-profile/api-key.md)
>
> Requires a Cloudways account with API access enabled. Uses email and API key to obtain a short-lived access token (60 mi...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/cloudways/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

82 actions

ActionDescription

List Alerts`cloudways_list_alerts`

Retrieve all CloudwaysBot alert notifications for your account including server events, security warnings, and operation...

List Alert Channels`cloudways_list_alert_channels`

Retrieve all configured CloudwaysBot notification channels (email, Slack, webhook) for your account

Create Alert Channel`cloudways_create_alert_channel`

Create a new CloudwaysBot notification channel to receive alerts via email, Slack, or webhook integration

Delete Alert Channel`cloudways_delete_alert_channel`

Permanently delete a CloudwaysBot notification channel, stopping all future alert deliveries through it

Mark Alert As Read`cloudways_mark_alert_as_read`

Mark a CloudwaysBot alert as read to acknowledge it and remove it from the unread notifications list

Mark All Alerts As Read`cloudways_mark_all_alerts_as_read`

Mark all CloudwaysBot alert notifications as read in a single bulk operation, acknowledging all pending alerts and clear...

Update Alert Channel`cloudways_update_alert_channel`

Update an existing CloudwaysBot notification channel's configuration including its name, delivery type, subscribed event...

List Applications`cloudways_list_applications`

Retrieve a list of all applications deployed across all servers in the Cloudways account via GET /apps

Add Application`cloudways_add_application`

Deploy a new application (WordPress, Laravel, PHP, Magento, etc.) to an existing Cloudways server via POST /app

Delete Application`cloudways_delete_application`

Permanently delete an application and all its data from a Cloudways server via DELETE /app/\{app\_id}

Update Application Label`cloudways_update_app_label`

Update the display label of an application on a Cloudways server via PUT /app/\{app\_id}

Clone Application`cloudways_clone_application`

Clone an application to the same Cloudways server with a new label via POST /app/clone

Clone Application To Another Server`cloudways_clone_application_to_server`

Clone an application to a different Cloudways server in the same account via POST /app/cloneToOtherServer

Get Application Credentials`cloudways_get_app_credentials`

Retrieve access credentials (admin URL, username, password) for a Cloudways application via GET /app/creds

Get Cron Jobs`cloudways_get_cron_list`

Retrieve all configured cron jobs for a Cloudways application via GET /app/manage/cronList

Update Cron Jobs`cloudways_update_cron_list`

Replace the entire cron job configuration for a Cloudways application via POST /app/manage/cronList

Update Application Domain Aliases`cloudways_update_app_aliases`

Update the domain aliases (additional custom domains) for a Cloudways application via POST /app/manage/aliases

Restore Application`cloudways_restore_app`

Restore an application from a previously created backup to a specific point in time via POST /app/manage/restore.

Create Application Credentials`cloudways_create_app_credentials`

Create a new set of access credentials (username and password) for a Cloudways application via POST /app/creds.

Update Application Credential`cloudways_update_app_credential`

Update an existing set of access credentials (username and password) for a Cloudways application via PUT /app/creds/\{app...

Delete Application Credential`cloudways_delete_app_credential`

Permanently delete a specific set of access credentials from a Cloudways application via DELETE /app/creds/\{app\_cred\_id}...

Change Application Access State`cloudways_change_app_access_state`

Enable or disable public access to a Cloudways application by toggling its access state via POST /app/state.

Update Application CNAME`cloudways_update_app_cname`

Set or update the CNAME (canonical domain name) for a Cloudways application via POST /app/manage/cname.

Update Application Webroot`cloudways_update_webroot`

Change the webroot directory path for a Cloudways application via POST /app/manage/webroot.

Get FPM Settings`cloudways_get_fpm_settings`

Retrieve the PHP-FPM (FastCGI Process Manager) configuration settings for a specific application via GET /app/manage/fpm...

Update FPM Settings`cloudways_update_fpm_settings`

Update the PHP-FPM (FastCGI Process Manager) configuration for a specific application via POST /app/manage/fpm\_setting.

Create Supervisord Queue`cloudways_create_supervisord_queue`

Create a new Supervisor daemon-managed background queue worker for a Cloudways application, commonly used for Laravel qu...

Get Supervisord Queues`cloudways_get_supervisord_queues`

Retrieve all Supervisord-managed background queue worker configurations for a Cloudways application, showing active queu...

Clone Staging Application`cloudways_clone_staging_app`

Clone an application to create a staging copy on the same server via POST /staging/app/cloneApp, enabling safe testing o...

Get Git SSH Key`cloudways_get_git_ssh_key`

Retrieve the SSH public key that Cloudways generated for Git-based deployments on a specific application, so it can be a...

Generate Git SSH Key`cloudways_generate_git_ssh_key`

Generate a new SSH key pair for Git deployments on an application, replacing any existing key

Get Git Branches`cloudways_get_git_branches`

List all branch names from a remote Git repository accessible by the application's SSH key

Git Clone`cloudways_git_clone`

Clone a remote Git repository branch into the application's deploy path for the initial code deployment

Git Pull`cloudways_git_pull`

Pull the latest commits from a remote Git branch into the application's deploy path to update the deployed code

Get Git Deployment History`cloudways_get_git_deployment_history`

Retrieve the chronological history of all Git deployments (clones and pulls) for an application, including timestamps an...

List Cloud Providers`cloudways_list_providers`

Retrieve all supported cloud infrastructure providers available on Cloudways for server provisioning, including DigitalO...

List Regions`cloudways_list_regions`

Retrieve all available geographic regions across cloud providers where Cloudways servers can be deployed, used for selec...

List Server Sizes`cloudways_list_server_sizes`

Retrieve all available server sizes and instance types across cloud providers, including CPU, RAM, storage, and bandwidt...

List Application Types`cloudways_list_app_types`

Retrieve all deployable application types on Cloudways, including WordPress, Laravel, Magento, PHP, and other supported...

List Packages`cloudways_list_packages`

Retrieve all available server software packages and their supported versions, such as PHP, MySQL, Apache, Nginx, Redis,...

List Settings`cloudways_list_settings`

Retrieve all configurable server and application settings with their allowed values, used as a reference for understandi...

List Backup Frequencies`cloudways_list_backup_frequencies`

Retrieve all available backup scheduling frequency options for Cloudways servers, used when configuring automated backup...

Get Operation Status`cloudways_get_operation_status`

Check the current status of an asynchronous Cloudways operation by its operation ID, used to poll long-running tasks lik...

Search Knowledge Base`cloudways_search_knowledge_base`

Search the Cloudways knowledge base articles by title keyword to find relevant help documentation, troubleshooting guide...

Get Countries List`cloudways_get_countries_list`

Retrieve the complete list of countries supported by Cloudways, typically used for billing address configuration, accoun...

Get Monitor Durations`cloudways_get_monitor_durations`

Retrieve all available monitoring duration options that define the time range for server and application performance mon...

Get Monitor Targets`cloudways_get_monitor_targets`

Retrieve all available monitoring target metrics (CPU, RAM, disk, bandwidth, etc.) that can be tracked for servers and a...

Get Monitoring Graph`cloudways_get_monitoring_graph`

Retrieve time-series monitoring metrics (CPU, RAM, disk, or bandwidth) for a Cloudways server over a specified duration

Get Disk Usage`cloudways_get_disk_usage`

Retrieve current disk usage statistics for a Cloudways server including total, used, and available space

List Projects`cloudways_list_projects`

Retrieve all projects in your Cloudways account, including their associated applications and server assignments

Create Project`cloudways_create_project`

Create a new project to logically group and organize applications and servers on your Cloudways account

Update Project`cloudways_update_project`

Update a project's name or reassign its applications to reorganize your Cloudways infrastructure

Delete Project`cloudways_delete_project`

Delete a project from your Cloudways account without affecting the applications or servers it contained

Install Let's Encrypt SSL`cloudways_install_lets_encrypt`

Provisions and installs a free Let's Encrypt SSL certificate for one or more domains on a Cloudways-hosted application,...

Revoke Let's Encrypt SSL`cloudways_revoke_lets_encrypt`

Revokes and removes a previously installed Let's Encrypt SSL certificate from a Cloudways application, disabling HTTPS f...

Get Whitelisted IPs For SSH/SFTP`cloudways_get_whitelisted_ips_ssh`

Retrieves the full list of IP addresses currently whitelisted for SSH and SFTP access on a Cloudways server, useful for...

Get Whitelisted IPs For MySQL`cloudways_get_whitelisted_ips_mysql`

Retrieves the full list of IP addresses currently whitelisted for remote MySQL database connections on a Cloudways serve...

Update Whitelisted IPs`cloudways_update_whitelisted_ips`

Adds or removes a single IP address from the SSH/SFTP or MySQL whitelist on a Cloudways server, controlling remote acces...

Update SSL Certificate`cloudways_update_ssl_certificate`

Uploads and installs a custom (non-Let's Encrypt) SSL certificate and its CA bundle on a Cloudways application for HTTPS...

List Servers`cloudways_list_servers`

Retrieve a list of all servers in your Cloudways account with their full configuration details via GET /server.

Create Server`cloudways_create_server`

Launch a new managed cloud server on a specified provider (DigitalOcean, Vultr, AWS, GCE, or Linode) via POST /server.

Delete Server`cloudways_delete_server`

Permanently delete a server and all its applications from your Cloudways account via DELETE /server/\{server\_id}.

Start Server`cloudways_start_server`

Start a stopped server to resume hosting and make all its applications accessible again via POST /server/start.

Stop Server`cloudways_stop_server`

Stop a running server to halt all hosted applications and services via POST /server/stop.

Restart Server`cloudways_restart_server`

Restart a running server to apply configuration changes or recover from issues via POST /server/restart.

Update Server Label`cloudways_update_server_label`

Update the display label of a server for organizational purposes via PUT /server/\{server\_id}.

Upgrade Server`cloudways_upgrade_server`

Vertically scale a server to a larger instance type for more CPU, RAM, and disk via POST /server/scaleServer.

Clone Server`cloudways_clone_server`

Clone an existing server and its application to a different cloud provider or region via POST /server/cloneServer.

Scale Server Resources`cloudways_scale_server_resources`

Scale a server's compute resources by changing its instance type via POST /server/scaleResources.

Get Server Settings`cloudways_get_server_settings`

Retrieve all configurable settings for a specific server including PHP, MySQL, and web server tuning via GET /server/man...

Backup Server`cloudways_backup_server`

Trigger an on-demand backup of a server and all its applications and databases via POST /server/manage/backup.

Update Backup Settings`cloudways_update_backup_settings`

Configure automated backup settings for a server including local backup storage, backup frequency, and retention period...

Get Varnish Settings`cloudways_get_varnish_settings`

Retrieve the Varnish cache configuration and VCL settings for a specific application on a server via GET /app/manage/var...

Update Varnish Settings`cloudways_update_varnish_settings`

Update the Varnish cache VCL (Varnish Configuration Language) rules for an application on a server via POST /app/manage/...

Update Server Settings`cloudways_update_server_settings`

Update PHP, MySQL, and web server configuration settings for a specific server via POST /server/manage/settings.

Scale Server Volume Size`cloudways_scale_server_volume_size`

Scale the storage volume size and type for a server to increase or adjust disk capacity via POST /server/scaleVolume.

Update Server Package`cloudways_update_server_package`

Update a specific software package on a server to a target version via POST /server/manage/package.

Get Service Status`cloudways_get_service_status`

Retrieve the running status of all managed services on a Cloudways server including Apache, Nginx, MySQL, PHP-FPM, Memca...

Change Service State`cloudways_change_service_state`

Start, stop, or restart a specific managed service (Apache, Nginx, MySQL, PHP-FPM, Memcached, Varnish, or Redis) on a Cl...

Create SSH Key`cloudways_create_ssh_key`

Upload an SSH public key to a Cloudways server, associating it with a specific application credential for secure shell a...

Update SSH Key`cloudways_update_ssh_key`

Rename an existing SSH key on a Cloudways server to update its human-readable label

Delete SSH Key`cloudways_delete_ssh_key`

Remove an SSH key from a Cloudways server, immediately revoking the associated shell access


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.