Skip to content

vultr/vultr-ruby

BranchesTags

Repository files navigation

vultr_ruby

VultrRuby - the Ruby gem for the Vultr API

Introduction

The Vultr API v2 is a set of HTTP endpoints that adhere to RESTful design principles and CRUD actions with predictable URIs. It uses standard HTTP response codes, authentication, and verbs. The API has consistent and well-formed JSON requests and responses with cursor-based pagination to simplify list handling. Error messages are descriptive and easy to understand. All functions of the Vultr customer portal are accessible via the API, enabling you to script complex unattended scenarios with any tool fluent in HTTP.

Requests

Communicate with the API by making an HTTP request at the correct endpoint. The chosen method determines the action taken.

Method Usage
DELETE Use the DELETE method to destroy a resource in your account. If it is not found, the operation will return a 4xx error and an appropriate message.
GET To retrieve information about a resource, use the GET method. The data is returned as a JSON object. GET methods are read-only and do not affect any resources.
PATCH Some resources support partial modification with PATCH, which modifies specific attributes without updating the entire object representation.
POST Issue a POST method to create a new object. Include all needed attributes in the request body encoded as JSON.
PUT Use the PUT method to update information about a resource. PUT will set new values on the item without regard to their current values.

Rate Limit: Vultr safeguards the API against bursts of incoming traffic based on the request's IP address to ensure stability for all users. If your application sends more than 30 requests per second, the API may return HTTP status code 429.

Response Codes

We use standard HTTP response codes to show the success or failure of requests. Response codes in the 2xx range indicate success, while codes in the 4xx range indicate an error, such as an authorization failure or a malformed request. All 4xx errors will return a JSON response object with an error attribute explaining the error. Codes in the 5xx range indicate a server-side problem preventing Vultr from fulfilling your request.

Response Description
200 OK The response contains your requested information.
201 Created Your request was accepted. The resource was created.
202 Accepted Your request was accepted. The resource was created or updated.
204 No Content Your request succeeded, there is no additional information returned.
400 Bad Request Your request was malformed.
401 Unauthorized You did not supply valid authentication credentials.
403 Forbidden You are not allowed to perform that action.
404 Not Found No results were found for your request.
429 Too Many Requests Your request exceeded the API rate limit.
500 Internal Server Error We were unable to perform the request due to server-side problems.

Meta and Pagination

Many API calls will return a meta object with paging information.

Definitions

Term Description
List The items returned from the database for your request (not necessarily shown in a single response depending on the cursor size).
Page A subset of the full list of items. Choose the size of a page with the per_page parameter.
Total The total attribute indicates the number of items in the full list.
Cursor Use the cursor query parameter to select a next or previous page.
Next & Prev Use the next and prev attributes of the links meta object as cursor values.

How to use Paging

If your result list total exceeds the default cursor size (the default depends on the route, but is usually 100 records) or the value defined by the per_page query param (when present) the response will be returned to you paginated.

Paging Example

These examples have abbreviated attributes and sample values. Your actual cursor values will be encoded alphanumeric strings.

To return a page with the first two plans in the List:

curl \"https://api.vultr.com/v2/plans?per_page=2\" \\
  -X GET \\
  -H \"Authorization: Bearer ${VULTR_API_KEY}\"

The API returns an object similar to this:

{
    \"plans\": [
        {
            \"id\": \"vc2-1c-2gb\",
            \"vcpu_count\": 1,
            \"ram\": 2048,
            \"locations\": []
        },
        {
            \"id\": \"vc2-24c-97gb\",
            \"vcpu_count\": 24,
            \"ram\": 98304,
            \"locations\": []
        }
    ],
    \"meta\": {
        \"total\": 19,
        \"links\": {
            \"next\": \"WxYzExampleNext\",
            \"prev\": \"WxYzExamplePrev\"
        }
    }
}

The object contains two plans. The total attribute indicates that 19 plans are available in the List. To navigate forward in the list, use the next value (WxYzExampleNext in this example) as your cursor query parameter.

curl \"https://api.vultr.com/v2/plans?per_page=2&cursor=WxYzExampleNext\" \\
  -X GET
  -H \"Authorization: Bearer ${VULTR_API_KEY}\"

Likewise, you can use the example prev value WxYzExamplePrev to navigate backward.

Parameters

You can pass information to the API with three different types of parameters.

Path parameters

Some API calls require variable parameters as part of the endpoint path. For example, to retrieve information about a user, supply the user-id in the endpoint.

curl \"https://api.vultr.com/v2/users/{user-id}\" \\
  -X GET \\
  -H \"Authorization: Bearer ${VULTR_API_KEY}\"

Query parameters

Some API calls allow filtering with query parameters. For example, the /v2/plans endpoint supports a type query parameter. Setting type=vhf instructs the API only to return High Frequency Compute plans in the list. You'll find more specifics about valid filters in the endpoint documentation below.

curl \"https://api.vultr.com/v2/plans?type=vhf\" \\
  -X GET \\
  -H \"Authorization: Bearer ${VULTR_API_KEY}\"

You can also combine filtering with paging. Use the per_page parameter to retreive a subset of vhf plans.

curl \"https://api.vultr.com/v2/plans?type=vhf&per_page=2\" \\
  -X GET \\
  -H \"Authorization: Bearer ${VULTR_API_KEY}\"

Request Body

PUT, POST, and PATCH methods may include an object in the request body with a content type of application/json. The documentation for each endpoint below has more information about the expected object.

API Example Conventions

The examples in this documentation use curl, a command-line HTTP client, to demonstrate useage. Linux and macOS computers usually have curl installed by default, and it's available for download on all popular platforms including Windows.

Each example is split across multiple lines with the \\ character, which is compatible with a bash terminal. A typical example looks like this:

curl \"https://api.vultr.com/v2/domains\" \\
  -X POST \\
  -H \"Authorization: Bearer ${VULTR_API_KEY}\" \\
  -H \"Content-Type: application/json\" \\
  --data '{
    \"domain\" : \"example.com\",
    \"ip\" : \"192.0.2.123\"
  }'
  • The -X parameter sets the request method. For consistency, we show the method on all examples, even though it's not explicitly required for GET methods.
  • The -H lines set required HTTP headers. These examples are formatted to expand the VULTR\_API\_KEY environment variable for your convenience.
  • Examples that require a JSON object in the request body pass the required data via the --data parameter.

All values in this guide are examples. Do not rely on the OS or Plan IDs listed in this guide; use the appropriate endpoint to retreive values before creating resources.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 2.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://www.vultr.com

Installation

Build a gem

To build the Ruby code into a gem:

gem build vultr_ruby.gemspec

Then either install the gem locally:

gem install ./vultr_ruby-1.0.0.gem

(for development, run gem install --dev ./vultr_ruby-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'vultr_ruby', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'vultr_ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'vultr_ruby'

# Setup authorization
VultrRuby.configure do |config|
  # Configure Bearer authorization: API Key
  config.access_token = 'YOUR_BEARER_TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
end

api_instance = VultrRuby::AccountApi.new

begin
  #Get Account Info
  result = api_instance.get_account
  p result
rescue VultrRuby::ApiError => e
  puts "Exception when calling AccountApi->get_account: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.vultr.com/v2

Class Method HTTP request Description
VultrRuby::AccountApi get_account GET /account Get Account Info
VultrRuby::ApplicationApi list_applications GET /applications List Applications
VultrRuby::BackupApi get_backup GET /backups/{backup-id} Get a Backup
VultrRuby::BackupApi list_backups GET /backups List Backups
VultrRuby::BaremetalApi attach_baremetals_vpc2 POST /bare-metals/{baremetal-id}/vpc2/attach Attach VPC 2.0 Network to Bare Metal Instance
VultrRuby::BaremetalApi create_baremetal POST /bare-metals Create Bare Metal Instance
VultrRuby::BaremetalApi delete_baremetal DELETE /bare-metals/{baremetal-id} Delete Bare Metal
VultrRuby::BaremetalApi detach_baremetal_vpc2 POST /bare-metals/{baremetal-id}/vpc2/detach Detach VPC 2.0 Network from Bare Metal Instance
VultrRuby::BaremetalApi get_bandwidth_baremetal GET /bare-metals/{baremetal-id}/bandwidth Bare Metal Bandwidth
VultrRuby::BaremetalApi get_bare_metal_userdata GET /bare-metals/{baremetal-id}/user-data Get Bare Metal User Data
VultrRuby::BaremetalApi get_bare_metal_vnc GET /bare-metals/{baremetal-id}/vnc Get VNC URL for a Bare Metal
VultrRuby::BaremetalApi get_bare_metals_upgrades GET /bare-metals/{baremetal-id}/upgrades Get Available Bare Metal Upgrades
VultrRuby::BaremetalApi get_baremetal GET /bare-metals/{baremetal-id} Get Bare Metal
VultrRuby::BaremetalApi get_ipv4_baremetal GET /bare-metals/{baremetal-id}/ipv4 Bare Metal IPv4 Addresses
VultrRuby::BaremetalApi get_ipv6_baremetal GET /bare-metals/{baremetal-id}/ipv6 Bare Metal IPv6 Addresses
VultrRuby::BaremetalApi halt_baremetal POST /bare-metals/{baremetal-id}/halt Halt Bare Metal
VultrRuby::BaremetalApi halt_baremetals POST /bare-metals/halt Halt Bare Metals
VultrRuby::BaremetalApi list_baremetal_vpc2 GET /bare-metals/{baremetal-id}/vpc2 List Bare Metal Instance VPC 2.0 Networks
VultrRuby::BaremetalApi list_baremetals GET /bare-metals List Bare Metal Instances
VultrRuby::BaremetalApi reboot_bare_metals POST /bare-metals/reboot Reboot Bare Metals
VultrRuby::BaremetalApi reboot_baremetal POST /bare-metals/{baremetal-id}/reboot Reboot Bare Metal
VultrRuby::BaremetalApi reinstall_baremetal POST /bare-metals/{baremetal-id}/reinstall Reinstall Bare Metal
VultrRuby::BaremetalApi start_bare_metals POST /bare-metals/start Start Bare Metals
VultrRuby::BaremetalApi start_baremetal POST /bare-metals/{baremetal-id}/start Start Bare Metal
VultrRuby::BaremetalApi update_baremetal PATCH /bare-metals/{baremetal-id} Update Bare Metal
VultrRuby::BillingApi get_invoice GET /billing/invoices/{invoice-id} Get Invoice
VultrRuby::BillingApi get_invoice_items GET /billing/invoices/{invoice-id}/items Get Invoice Items
VultrRuby::BillingApi list_billing_history GET /billing/history List Billing History
VultrRuby::BillingApi list_invoices GET /billing/invoices List Invoices
VultrRuby::BlockApi attach_block POST /blocks/{block-id}/attach Attach Block Storage
VultrRuby::BlockApi create_block POST /blocks Create Block Storage
VultrRuby::BlockApi delete_block DELETE /blocks/{block-id} Delete Block Storage
VultrRuby::BlockApi detach_block POST /blocks/{block-id}/detach Detach Block Storage
VultrRuby::BlockApi get_block GET /blocks/{block-id} Get Block Storage
VultrRuby::BlockApi list_blocks GET /blocks List Block storages
VultrRuby::BlockApi update_block PATCH /blocks/{block-id} Update Block Storage
VultrRuby::ContainerRegistryApi create_registry POST /registry Create Container Registry
VultrRuby::ContainerRegistryApi create_registry_docker_credentials OPTIONS /registry/{registry-id}/docker-credentials?expiry_seconds=0&read_write=false Create Docker Credentials
VultrRuby::ContainerRegistryApi create_registry_kubernetes_docker_credentials OPTIONS /registry/{registry-id}/docker-credentials/kubernetes?expiry_seconds=0&read_write=false&base64_encode=false Create Docker Credentials for Kubernetes
VultrRuby::ContainerRegistryApi delete_registry DELETE /registry/{registry-id} Delete Container Registry
VultrRuby::ContainerRegistryApi delete_repository DELETE /registry/{registry-id}/repository/{repository-image} Delete Repository
VultrRuby::ContainerRegistryApi list_registries GET /registries List Container Registries
VultrRuby::ContainerRegistryApi list_registry_plans GET /registry/plan/list List Registry Plans
VultrRuby::ContainerRegistryApi list_registry_regions GET /registry/region/list List Registry Regions
VultrRuby::ContainerRegistryApi list_registry_repositories GET /registry/{registry-id}/repositories List Repositories
VultrRuby::ContainerRegistryApi read_registry GET /registry/{registry-id} Read Container Registry
VultrRuby::ContainerRegistryApi read_registry_repository GET /registry/{registry-id}/repository/{repository-image} Read Repository
VultrRuby::ContainerRegistryApi update_registry PUT /registry/{registry-id} Update Container Registry
VultrRuby::ContainerRegistryApi update_repository PUT /registry/{registry-id}/repository/{repository-image} Update Repository
VultrRuby::DnsApi create_dns_domain POST /domains Create DNS Domain
VultrRuby::DnsApi create_dns_domain_record POST /domains/{dns-domain}/records Create Record
VultrRuby::DnsApi delete_dns_domain DELETE /domains/{dns-domain} Delete Domain
VultrRuby::DnsApi delete_dns_domain_record DELETE /domains/{dns-domain}/records/{record-id} Delete Record
VultrRuby::DnsApi get_dns_domain GET /domains/{dns-domain} Get DNS Domain
VultrRuby::DnsApi get_dns_domain_dnssec GET /domains/{dns-domain}/dnssec Get DNSSec Info
VultrRuby::DnsApi get_dns_domain_record GET /domains/{dns-domain}/records/{record-id} Get Record
VultrRuby::DnsApi get_dns_domain_soa GET /domains/{dns-domain}/soa Get SOA information
VultrRuby::DnsApi list_dns_domain_records GET /domains/{dns-domain}/records List Records
VultrRuby::DnsApi list_dns_domains GET /domains List DNS Domains
VultrRuby::DnsApi update_dns_domain PUT /domains/{dns-domain} Update a DNS Domain
VultrRuby::DnsApi update_dns_domain_record PATCH /domains/{dns-domain}/records/{record-id} Update Record
VultrRuby::DnsApi update_dns_domain_soa PATCH /domains/{dns-domain}/soa Update SOA information
VultrRuby::FirewallApi create_firewall_group POST /firewalls Create Firewall Group
VultrRuby::FirewallApi delete_firewall_group DELETE /firewalls/{firewall-group-id} Delete Firewall Group
VultrRuby::FirewallApi delete_firewall_group_rule DELETE /firewalls/{firewall-group-id}/rules/{firewall-rule-id} Delete Firewall Rule
VultrRuby::FirewallApi get_firewall_group GET /firewalls/{firewall-group-id} Get Firewall Group
VultrRuby::FirewallApi get_firewall_group_rule GET /firewalls/{firewall-group-id}/rules/{firewall-rule-id} Get Firewall Rule
VultrRuby::FirewallApi list_firewall_group_rules GET /firewalls/{firewall-group-id}/rules List Firewall Rules
VultrRuby::FirewallApi list_firewall_groups GET /firewalls List Firewall Groups
VultrRuby::FirewallApi post_firewalls_firewall_group_id_rules POST /firewalls/{firewall-group-id}/rules Create Firewall Rules
VultrRuby::FirewallApi update_firewall_group PUT /firewalls/{firewall-group-id} Update Firewall Group
VultrRuby::InstancesApi attach_instance_iso POST /instances/{instance-id}/iso/attach Attach ISO to Instance
VultrRuby::InstancesApi attach_instance_network POST /instances/{instance-id}/private-networks/attach Attach Private Network to Instance
VultrRuby::InstancesApi attach_instance_vpc POST /instances/{instance-id}/vpcs/attach Attach VPC to Instance
VultrRuby::InstancesApi attach_instance_vpc2 POST /instances/{instance-id}/vpc2/attach Attach VPC 2.0 Network to Instance
VultrRuby::InstancesApi create_instance POST /instances Create Instance
VultrRuby::InstancesApi create_instance_backup_schedule POST /instances/{instance-id}/backup-schedule Set Instance Backup Schedule
VultrRuby::InstancesApi create_instance_ipv4 POST /instances/{instance-id}/ipv4 Create IPv4
VultrRuby::InstancesApi create_instance_reverse_ipv4 POST /instances/{instance-id}/ipv4/reverse Create Instance Reverse IPv4
VultrRuby::InstancesApi create_instance_reverse_ipv6 POST /instances/{instance-id}/ipv6/reverse Create Instance Reverse IPv6
VultrRuby::InstancesApi delete_instance DELETE /instances/{instance-id} Delete Instance
VultrRuby::InstancesApi delete_instance_ipv4 DELETE /instances/{instance-id}/ipv4/{ipv4} Delete IPv4 Address
VultrRuby::InstancesApi delete_instance_reverse_ipv6 DELETE /instances/{instance-id}/ipv6/reverse/{ipv6} Delete Instance Reverse IPv6
VultrRuby::InstancesApi detach_instance_iso POST /instances/{instance-id}/iso/detach Detach ISO from instance
VultrRuby::InstancesApi detach_instance_network POST /instances/{instance-id}/private-networks/detach Detach Private Network from Instance.
VultrRuby::InstancesApi detach_instance_vpc POST /instances/{instance-id}/vpcs/detach Detach VPC from Instance
VultrRuby::InstancesApi detach_instance_vpc2 POST /instances/{instance-id}/vpc2/detach Detach VPC 2.0 Network from Instance
VultrRuby::InstancesApi get_instance GET /instances/{instance-id} Get Instance
VultrRuby::InstancesApi get_instance_backup_schedule GET /instances/{instance-id}/backup-schedule Get Instance Backup Schedule
VultrRuby::InstancesApi get_instance_bandwidth GET /instances/{instance-id}/bandwidth Instance Bandwidth
VultrRuby::InstancesApi get_instance_ipv4 GET /instances/{instance-id}/ipv4 List Instance IPv4 Information
VultrRuby::InstancesApi get_instance_ipv6 GET /instances/{instance-id}/ipv6 Get Instance IPv6 Information
VultrRuby::InstancesApi get_instance_iso_status GET /instances/{instance-id}/iso Get Instance ISO Status
VultrRuby::InstancesApi get_instance_neighbors GET /instances/{instance-id}/neighbors Get Instance neighbors
VultrRuby::InstancesApi get_instance_upgrades GET /instances/{instance-id}/upgrades Get Available Instance Upgrades
VultrRuby::InstancesApi get_instance_userdata GET /instances/{instance-id}/user-data Get Instance User Data
VultrRuby::InstancesApi halt_instance POST /instances/{instance-id}/halt Halt Instance
VultrRuby::InstancesApi halt_instances POST /instances/halt Halt Instances
VultrRuby::InstancesApi list_instance_ipv6_reverse GET /instances/{instance-id}/ipv6/reverse List Instance IPv6 Reverse
VultrRuby::InstancesApi list_instance_private_networks GET /instances/{instance-id}/private-networks List instance Private Networks
VultrRuby::InstancesApi list_instance_vpc2 GET /instances/{instance-id}/vpc2 List Instance VPC 2.0 Networks
VultrRuby::InstancesApi list_instance_vpcs GET /instances/{instance-id}/vpcs List instance VPCs
VultrRuby::InstancesApi list_instances GET /instances List Instances
VultrRuby::InstancesApi post_instances_instance_id_ipv4_reverse_default POST /instances/{instance-id}/ipv4/reverse/default Set Default Reverse DNS Entry
VultrRuby::InstancesApi reboot_instance POST /instances/{instance-id}/reboot Reboot Instance
VultrRuby::InstancesApi reboot_instances POST /instances/reboot Reboot instances
VultrRuby::InstancesApi reinstall_instance POST /instances/{instance-id}/reinstall Reinstall Instance
VultrRuby::InstancesApi restore_instance POST /instances/{instance-id}/restore Restore Instance
VultrRuby::InstancesApi start_instance POST /instances/{instance-id}/start Start instance
VultrRuby::InstancesApi start_instances POST /instances/start Start instances
VultrRuby::InstancesApi update_instance PATCH /instances/{instance-id} Update Instance
VultrRuby::IsoApi create_iso POST /iso Create ISO
VultrRuby::IsoApi delete_iso DELETE /iso/{iso-id} Delete ISO
VultrRuby::IsoApi iso_get GET /iso/{iso-id} Get ISO
VultrRuby::IsoApi list_isos GET /iso List ISOs
VultrRuby::IsoApi list_public_isos GET /iso-public List Public ISOs
VultrRuby::KubernetesApi create_kubernetes_cluster POST /kubernetes/clusters Create Kubernetes Cluster
VultrRuby::KubernetesApi create_nodepools POST /kubernetes/clusters/{vke-id}/node-pools Create NodePool
VultrRuby::KubernetesApi delete_kubernetes_cluster DELETE /kubernetes/clusters/{vke-id} Delete Kubernetes Cluster
VultrRuby::KubernetesApi delete_kubernetes_cluster_vke_id_delete_with_linked_resources DELETE /kubernetes/clusters/{vke-id}/delete-with-linked-resources Delete VKE Cluster and All Related Resources
VultrRuby::KubernetesApi delete_nodepool DELETE /kubernetes/clusters/{vke-id}/node-pools/{nodepool-id} Delete Nodepool
VultrRuby::KubernetesApi delete_nodepool_instance DELETE /kubernetes/clusters/{vke-id}/node-pools/{nodepool-id}/nodes/{node-id} Delete NodePool Instance
VultrRuby::KubernetesApi get_kubernetes_available_upgrades GET /kubernetes/clusters/{vke-id}/available-upgrades Get Kubernetes Available Upgrades
VultrRuby::KubernetesApi get_kubernetes_clusters GET /kubernetes/clusters/{vke-id} Get Kubernetes Cluster
VultrRuby::KubernetesApi get_kubernetes_clusters_config GET /kubernetes/clusters/{vke-id}/config Get Kubernetes Cluster Kubeconfig
VultrRuby::KubernetesApi get_kubernetes_resources GET /kubernetes/clusters/{vke-id}/resources Get Kubernetes Resources
VultrRuby::KubernetesApi get_kubernetes_versions GET /kubernetes/versions Get Kubernetes Versions
VultrRuby::KubernetesApi get_nodepool GET /kubernetes/clusters/{vke-id}/node-pools/{nodepool-id} Get NodePool
VultrRuby::KubernetesApi get_nodepools GET /kubernetes/clusters/{vke-id}/node-pools List NodePools
VultrRuby::KubernetesApi list_kubernetes_clusters GET /kubernetes/clusters List all Kubernetes Clusters
VultrRuby::KubernetesApi recycle_nodepool_instance POST /kubernetes/clusters/{vke-id}/node-pools/{nodepool-id}/nodes/{node-id}/recycle Recycle a NodePool Instance
VultrRuby::KubernetesApi start_kubernetes_cluster_upgrade POST /kubernetes/clusters/{vke-id}/upgrades Start Kubernetes Cluster Upgrade
VultrRuby::KubernetesApi update_kubernetes_cluster PUT /kubernetes/clusters/{vke-id} Update Kubernetes Cluster
VultrRuby::KubernetesApi update_nodepool PATCH /kubernetes/clusters/{vke-id}/node-pools/{nodepool-id} Update Nodepool
VultrRuby::LoadBalancerApi create_load_balancer POST /load-balancers Create Load Balancer
VultrRuby::LoadBalancerApi create_load_balancer_forwarding_rules POST /load-balancers/{load-balancer-id}/forwarding-rules Create Forwarding Rule
VultrRuby::LoadBalancerApi delete_load_balancer DELETE /load-balancers/{load-balancer-id} Delete Load Balancer
VultrRuby::LoadBalancerApi delete_load_balancer_forwarding_rule DELETE /load-balancers/{load-balancer-id}/forwarding-rules/{forwarding-rule-id} Delete Forwarding Rule
VultrRuby::LoadBalancerApi delete_load_balancer_ssl DELETE /load-balancers/{load-balancer-id}/ssl Delete Load Balancer SSL
VultrRuby::LoadBalancerApi get_load_balancer GET /load-balancers/{load-balancer-id} Get Load Balancer
VultrRuby::LoadBalancerApi get_load_balancer_forwarding_rule GET /load-balancers/{load-balancer-id}/forwarding-rules/{forwarding-rule-id} Get Forwarding Rule
VultrRuby::LoadBalancerApi get_loadbalancer_firewall_rule GET /load-balancers/{loadbalancer-id}/firewall-rules/{firewall-rule-id} Get Firewall Rule
VultrRuby::LoadBalancerApi list_load_balancer_forwarding_rules GET /load-balancers/{load-balancer-id}/forwarding-rules List Forwarding Rules
VultrRuby::LoadBalancerApi list_load_balancers GET /load-balancers List Load Balancers
VultrRuby::LoadBalancerApi list_loadbalancer_firewall_rules GET /load-balancers/{loadbalancer-id}/firewall-rules List Firewall Rules
VultrRuby::LoadBalancerApi update_load_balancer PATCH /load-balancers/{load-balancer-id} Update Load Balancer
VultrRuby::ManagedDatabasesApi create_connection_pool POST /databases/{database-id}/connection-pools Create Connection Pool
VultrRuby::ManagedDatabasesApi create_database POST /databases Create Managed Database
VultrRuby::ManagedDatabasesApi create_database_db POST /databases/{database-id}/dbs Create Logical Database
VultrRuby::ManagedDatabasesApi create_database_user POST /databases/{database-id}/users Create Database User
VultrRuby::ManagedDatabasesApi database_add_read_replica POST /databases/{database-id}/read-replica Add Read-Only Replica
VultrRuby::ManagedDatabasesApi database_detach_migration DELETE /databases/{database-id}/migration Detach Migration
VultrRuby::ManagedDatabasesApi database_fork POST /databases/{database-id}/fork Fork Managed Database
VultrRuby::ManagedDatabasesApi database_promote_read_replica POST /databases/{database-id}/promote-read-replica Promote Read-Only Replica
VultrRuby::ManagedDatabasesApi database_restore_from_backup POST /databases/{database-id}/restore Restore from Backup
VultrRuby::ManagedDatabasesApi database_start_migration POST /databases/{database-id}/migration Start Migration
VultrRuby::ManagedDatabasesApi delete_connection_pool DELETE /databases/{database-id}/connection-pools/{pool-name} Delete Connection Pool
VultrRuby::ManagedDatabasesApi delete_database DELETE /databases/{database-id} Delete Managed Database
VultrRuby::ManagedDatabasesApi delete_database_db DELETE /databases/{database-id}/dbs/{db-name} Delete Logical Database
VultrRuby::ManagedDatabasesApi delete_database_user DELETE /databases/{database-id}/users/{username} Delete Database User
VultrRuby::ManagedDatabasesApi get_backup_information GET /databases/{database-id}/backups Get Backup Information
VultrRuby::ManagedDatabasesApi get_connection_pool GET /databases/{database-id}/connection-pools/{pool-name} Get Connection Pool
VultrRuby::ManagedDatabasesApi get_database GET /databases/{database-id} Get Managed Database
VultrRuby::ManagedDatabasesApi get_database_db GET /databases/{database-id}/dbs/{db-name} Get Logical Database
VultrRuby::ManagedDatabasesApi get_database_usage GET /databases/{database-id}/usage Get Database Usage Information
VultrRuby::ManagedDatabasesApi get_database_user GET /databases/{database-id}/users/{username} Get Database User
VultrRuby::ManagedDatabasesApi list_advanced_options GET /databases/{database-id}/advanced-options List Advanced Options
VultrRuby::ManagedDatabasesApi list_available_versions GET /databases/{database-id}/version-upgrade List Available Versions
VultrRuby::ManagedDatabasesApi list_connection_pools GET /databases/{database-id}/connection-pools List Connection Pools
VultrRuby::ManagedDatabasesApi list_database_dbs GET /databases/{database-id}/dbs List Logical Databases
VultrRuby::ManagedDatabasesApi list_database_plans GET /databases/plans List Managed Database Plans
VultrRuby::ManagedDatabasesApi list_database_users GET /databases/{database-id}/users List Database Users
VultrRuby::ManagedDatabasesApi list_databases GET /databases List Managed Databases
VultrRuby::ManagedDatabasesApi list_maintenance_updates GET /databases/{database-id}/maintenance List Maintenance Updates
VultrRuby::ManagedDatabasesApi list_service_alerts POST /databases/{database-id}/alerts List Service Alerts
VultrRuby::ManagedDatabasesApi set_database_user_acl PUT /databases/{database-id}/users/{username}/access-control Set Database User Access Control
VultrRuby::ManagedDatabasesApi start_maintenance_updates POST /databases/{database-id}/maintenance Start Maintenance Updates
VultrRuby::ManagedDatabasesApi start_version_upgrade POST /databases/{database-id}/version-upgrade Start Version Upgrade
VultrRuby::ManagedDatabasesApi update_advanced_options PUT /databases/{database-id}/advanced-options Update Advanced Options
VultrRuby::ManagedDatabasesApi update_connection_pool PUT /databases/{database-id}/connection-pools/{pool-name} Update Connection Pool
VultrRuby::ManagedDatabasesApi update_database PUT /databases/{database-id} Update Managed Database
VultrRuby::ManagedDatabasesApi update_database_user PUT /databases/{database-id}/users/{username} Update Database User
VultrRuby::ManagedDatabasesApi view_migration_status GET /databases/{database-id}/migration Get Migration Status
VultrRuby::OsApi list_os GET /os List OS
VultrRuby::PlansApi list_metal_plans GET /plans-metal List Bare Metal Plans
VultrRuby::PlansApi list_plans GET /plans List Plans
VultrRuby::PrivateNetworksApi create_network POST /private-networks Create a Private Network
VultrRuby::PrivateNetworksApi delete_network DELETE /private-networks/{network-id} Delete a private network
VultrRuby::PrivateNetworksApi get_network GET /private-networks/{network-id} Get a private network
VultrRuby::PrivateNetworksApi list_networks GET /private-networks List Private Networks
VultrRuby::PrivateNetworksApi update_network PUT /private-networks/{network-id} Update a Private Network
VultrRuby::RegionApi list_available_plans_region GET /regions/{region-id}/availability List available plans in region
VultrRuby::RegionApi list_regions GET /regions List Regions
VultrRuby::ReservedIpApi attach_reserved_ip POST /reserved-ips/{reserved-ip}/attach Attach Reserved IP
VultrRuby::ReservedIpApi convert_reserved_ip POST /reserved-ips/convert Convert Instance IP to Reserved IP
VultrRuby::ReservedIpApi create_reserved_ip POST /reserved-ips Create Reserved IP
VultrRuby::ReservedIpApi delete_reserved_ip DELETE /reserved-ips/{reserved-ip} Delete Reserved IP
VultrRuby::ReservedIpApi detach_reserved_ip POST /reserved-ips/{reserved-ip}/detach Detach Reserved IP
VultrRuby::ReservedIpApi get_reserved_ip GET /reserved-ips/{reserved-ip} Get Reserved IP
VultrRuby::ReservedIpApi list_reserved_ips GET /reserved-ips List Reserved IPs
VultrRuby::ReservedIpApi patch_reserved_ips_reserved_ip PATCH /reserved-ips/{reserved-ip} Update Reserved IP
VultrRuby::S3Api create_object_storage POST /object-storage Create Object Storage
VultrRuby::S3Api delete_object_storage DELETE /object-storage/{object-storage-id} Delete Object Storage
VultrRuby::S3Api get_object_storage GET /object-storage/{object-storage-id} Get Object Storage
VultrRuby::S3Api list_object_storage_clusters GET /object-storage/clusters Get All Clusters
VultrRuby::S3Api list_object_storages GET /object-storage List Object Storages
VultrRuby::S3Api regenerate_object_storage_keys POST /object-storage/{object-storage-id}/regenerate-keys Regenerate Object Storage Keys
VultrRuby::S3Api update_object_storage PUT /object-storage/{object-storage-id} Update Object Storage
VultrRuby::SnapshotApi create_snapshot POST /snapshots Create Snapshot
VultrRuby::SnapshotApi create_snapshot_create_from_url POST /snapshots/create-from-url Create Snapshot from URL
VultrRuby::SnapshotApi delete_snapshot DELETE /snapshots/{snapshot-id} Delete Snapshot
VultrRuby::SnapshotApi get_snapshot GET /snapshots/{snapshot-id} Get Snapshot
VultrRuby::SnapshotApi list_snapshots GET /snapshots List Snapshots
VultrRuby::SnapshotApi put_snapshots_snapshot_id PUT /snapshots/{snapshot-id} Update Snapshot
VultrRuby::SshApi create_ssh_key POST /ssh-keys Create SSH key
VultrRuby::SshApi delete_ssh_key DELETE /ssh-keys/{ssh-key-id} Delete SSH Key
VultrRuby::SshApi get_ssh_key GET /ssh-keys/{ssh-key-id} Get SSH Key
VultrRuby::SshApi list_ssh_keys GET /ssh-keys List SSH Keys
VultrRuby::SshApi update_ssh_key PATCH /ssh-keys/{ssh-key-id} Update SSH Key
VultrRuby::StartupApi create_startup_script POST /startup-scripts Create Startup Script
VultrRuby::StartupApi delete_startup_script DELETE /startup-scripts/{startup-id} Delete Startup Script
VultrRuby::StartupApi get_startup_script GET /startup-scripts/{startup-id} Get Startup Script
VultrRuby::StartupApi list_startup_scripts GET /startup-scripts List Startup Scripts
VultrRuby::StartupApi update_startup_script PATCH /startup-scripts/{startup-id} Update Startup Script
VultrRuby::SubaccountApi create_subaccount POST /subaccounts Create Sub-Account
VultrRuby::SubaccountApi list_subaccounts GET /subaccounts List Sub-Accounts
VultrRuby::UsersApi create_user POST /users Create User
VultrRuby::UsersApi delete_user DELETE /users/{user-id} Delete User
VultrRuby::UsersApi get_user GET /users/{user-id} Get User
VultrRuby::UsersApi list_users GET /users Get Users
VultrRuby::UsersApi update_user PATCH /users/{user-id} Update User
VultrRuby::VPC2Api attach_vpc2_nodes POST /vpc2/{vpc-id}/nodes/attach Attach nodes to a VPC 2.0 network
VultrRuby::VPC2Api create_vpc2 POST /vpc2 Create a VPC 2.0 network
VultrRuby::VPC2Api delete_vpc2 DELETE /vpc2/{vpc-id} Delete a VPC 2.0 network
VultrRuby::VPC2Api detach_vpc2_nodes POST /vpc2/{vpc-id}/nodes/detach Remove nodes from a VPC 2.0 network
VultrRuby::VPC2Api get_vpc2 GET /vpc2/{vpc-id} Get a VPC 2.0 network
VultrRuby::VPC2Api list_vpc2 GET /vpc2 List VPC 2.0 networks
VultrRuby::VPC2Api list_vpc2_nodes GET /vpc2/{vpc-id}/nodes Get a list of nodes attached to a VPC 2.0 network
VultrRuby::VPC2Api update_vpc2 PUT /vpc2/{vpc-id} Update a VPC 2.0 network
VultrRuby::VPCsApi create_vpc POST /vpcs Create a VPC
VultrRuby::VPCsApi delete_vpc DELETE /vpcs/{vpc-id} Delete a VPC
VultrRuby::VPCsApi get_vpc GET /vpcs/{vpc-id} Get a VPC
VultrRuby::VPCsApi list_vpcs GET /vpcs List VPCs
VultrRuby::VPCsApi update_vpc PUT /vpcs/{vpc-id} Update a VPC

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

API Key

  • Type: Bearer authentication

About

No description, website, or topics provided.

Resources

Readme

License

Apache-2.0 license

Code of conduct

Code of conduct
Activity
Custom properties

Stars

0 stars

Watchers

3 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages