Cloudways

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Permanently delete a specific set of access credentials from a Cloudways application via DELETE /app/creds/{app_cred_id}…

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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