Skip to content

Cloudways Ruby List Endpoints

Bradley J Potts edited this page Nov 1, 2024 · 1 revision

This gem provides a Ruby client for interacting with Cloudways list endpoints, enabling retrieval of various resources from Cloudways' API. Below are the available list endpoints and their usage.

Installation

Add this line to your application's Gemfile:

gem 'ruby_api_pack_cloudways'

And then execute:

bundle install

Usage

Configuration

Set up configuration for Cloudways API access in your application:

RubyApiPackCloudways.configure do |config|
  config.api_url = 'https://api.cloudways.com/api/v1'
  config.api_email = 'your_email'
  config.api_key = 'your_api_key'
end

Available List Endpoints

Below is a list of all available list endpoints provided by the CwLists class in the ruby_api_pack_cloudways gem.

1. List Apps

List Applications Fetches a list of all applications.

RubyApiPackCloudways::Api::CwLists.app_list

2. List Backup Frequencies

List Backup Frequencies Retrieves available backup frequency options.

RubyApiPackCloudways::Api::CwLists.backup_frequency_list

3. List Countries

List Countries Fetches a list of supported countries.

RubyApiPackCloudways::Api::CwLists.country_list

4. List Monitor Durations

List Monitor Durations Retrieves monitoring duration options.

RubyApiPackCloudways::Api::CwLists.monitor_duration_list

5. List Monitor Targets

List Monitor Targets Fetches available monitoring targets.

RubyApiPackCloudways::Api::CwLists.monitor_target_list

6. List Packages

List Packages Retrieves a list of available packages.

RubyApiPackCloudways::Api::CwLists.package_list

7. List Providers

List Providers Fetches a list of cloud providers.

RubyApiPackCloudways::Api::CwLists.provider_list

8. List Regions

List Regions Retrieves available regions.

RubyApiPackCloudways::Api::CwLists.region_list

9. List Server Sizes

List Server Sizes Fetches available server sizes.

RubyApiPackCloudways::Api::CwLists.server_size_list

10. List Settings

List Settings Retrieves a list of server settings.

RubyApiPackCloudways::Api::CwLists.setting_list