VultrRuby - the Ruby gem for the Vultr API

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.

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

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.

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.

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

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.

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.

You can pass information to the API with three different types of 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}\"

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}\"

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.

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

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'

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 using -I as follows:

ruby -Ilib script.rb

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

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

• VultrRuby::Account
• VultrRuby::Application
• VultrRuby::AttachBaremetalsVpc2Request
• VultrRuby::AttachBlockRequest
• VultrRuby::AttachInstanceIso202Response
• VultrRuby::AttachInstanceIso202ResponseIsoStatus
• VultrRuby::AttachInstanceIsoRequest
• VultrRuby::AttachInstanceNetworkRequest
• VultrRuby::AttachInstanceVpc2Request
• VultrRuby::AttachInstanceVpcRequest
• VultrRuby::AttachReservedIpRequest
• VultrRuby::AttachVpc2NodesRequest
• VultrRuby::Backup
• VultrRuby::BackupSchedule
• VultrRuby::Bandwidth
• VultrRuby::Baremetal
• VultrRuby::BaremetalIpv4
• VultrRuby::BaremetalIpv6
• VultrRuby::Billing
• VultrRuby::Blockstorage
• VultrRuby::Clusters
• VultrRuby::ConnectionPool
• VultrRuby::ConvertReservedIpRequest
• VultrRuby::CreateBaremetal202Response
• VultrRuby::CreateBaremetalRequest
• VultrRuby::CreateBlock202Response
• VultrRuby::CreateBlockRequest
• VultrRuby::CreateConnectionPool202Response
• VultrRuby::CreateConnectionPoolRequest
• VultrRuby::CreateDatabase202Response
• VultrRuby::CreateDatabaseDb202Response
• VultrRuby::CreateDatabaseDbRequest
• VultrRuby::CreateDatabaseRequest
• VultrRuby::CreateDatabaseUser202Response
• VultrRuby::CreateDatabaseUserRequest
• VultrRuby::CreateDnsDomain200Response
• VultrRuby::CreateDnsDomainRecord201Response
• VultrRuby::CreateDnsDomainRecordRequest
• VultrRuby::CreateDnsDomainRequest
• VultrRuby::CreateFirewallGroup201Response
• VultrRuby::CreateFirewallGroupRequest
• VultrRuby::CreateInstance202Response
• VultrRuby::CreateInstanceBackupScheduleRequest
• VultrRuby::CreateInstanceIpv4Request
• VultrRuby::CreateInstanceRequest
• VultrRuby::CreateInstanceReverseIpv4Request
• VultrRuby::CreateInstanceReverseIpv6Request
• VultrRuby::CreateIso201Response
• VultrRuby::CreateIsoRequest
• VultrRuby::CreateKubernetesCluster201Response
• VultrRuby::CreateKubernetesClusterRequest
• VultrRuby::CreateKubernetesClusterRequestNodePoolsInner
• VultrRuby::CreateLoadBalancer202Response
• VultrRuby::CreateLoadBalancerForwardingRulesRequest
• VultrRuby::CreateLoadBalancerRequest
• VultrRuby::CreateLoadBalancerRequestFirewallRulesInner
• VultrRuby::CreateLoadBalancerRequestForwardingRulesInner
• VultrRuby::CreateLoadBalancerRequestHealthCheck
• VultrRuby::CreateLoadBalancerRequestSsl
• VultrRuby::CreateLoadBalancerRequestStickySession
• VultrRuby::CreateNetworkRequest
• VultrRuby::CreateNodepools201Response
• VultrRuby::CreateNodepoolsRequest
• VultrRuby::CreateObjectStorage202Response
• VultrRuby::CreateObjectStorageRequest
• VultrRuby::CreateRegistryRequest
• VultrRuby::CreateReservedIpRequest
• VultrRuby::CreateSnapshotCreateFromUrlRequest
• VultrRuby::CreateSnapshotRequest
• VultrRuby::CreateSshKeyRequest
• VultrRuby::CreateStartupScriptRequest
• VultrRuby::CreateSubaccount201Response
• VultrRuby::CreateSubaccountRequest
• VultrRuby::CreateUserRequest
• VultrRuby::CreateVpc2Request
• VultrRuby::CreateVpcRequest
• VultrRuby::Database
• VultrRuby::DatabaseAddReadReplicaRequest
• VultrRuby::DatabaseConnections
• VultrRuby::DatabaseDb
• VultrRuby::DatabaseFerretdbCredentials
• VultrRuby::DatabaseForkRequest
• VultrRuby::DatabaseLatestBackup
• VultrRuby::DatabaseOldestBackup
• VultrRuby::DatabaseRestoreFromBackupRequest
• VultrRuby::DatabaseStartMigrationRequest
• VultrRuby::DatabaseUsage
• VultrRuby::DatabaseUsageCpu
• VultrRuby::DatabaseUsageDisk
• VultrRuby::DatabaseUsageMemory
• VultrRuby::DatabaseUser
• VultrRuby::DatabaseUserAccessControl
• VultrRuby::DbaasAlerts
• VultrRuby::DbaasAvailableOptions
• VultrRuby::DbaasMeta
• VultrRuby::DbaasMigration
• VultrRuby::DbaasMigrationCredentials
• VultrRuby::DbaasPlan
• VultrRuby::DetachBaremetalVpc2Request
• VultrRuby::DetachBlockRequest
• VultrRuby::DetachInstanceIso202Response
• VultrRuby::DetachInstanceIso202ResponseIsoStatus
• VultrRuby::DetachInstanceNetworkRequest
• VultrRuby::DetachInstanceVpc2Request
• VultrRuby::DetachInstanceVpcRequest
• VultrRuby::DetachVpc2NodesRequest
• VultrRuby::DnsRecord
• VultrRuby::DnsSoa
• VultrRuby::Domain
• VultrRuby::FirewallGroup
• VultrRuby::FirewallRule
• VultrRuby::ForwardingRule
• VultrRuby::GetAccount200Response
• VultrRuby::GetBackup200Response
• VultrRuby::GetBackupInformation200Response
• VultrRuby::GetBandwidthBaremetal200Response
• VultrRuby::GetBandwidthBaremetal200ResponseBandwidth
• VultrRuby::GetBareMetalUserdata200Response
• VultrRuby::GetBareMetalUserdata200ResponseUserData
• VultrRuby::GetBareMetalVnc200Response
• VultrRuby::GetBareMetalVnc200ResponseVnc
• VultrRuby::GetBareMetalsUpgrades200Response
• VultrRuby::GetBareMetalsUpgrades200ResponseUpgrades
• VultrRuby::GetBaremetal200Response
• VultrRuby::GetDatabaseUsage200Response
• VultrRuby::GetDnsDomainDnssec200Response
• VultrRuby::GetDnsDomainSoa200Response
• VultrRuby::GetInstanceBackupSchedule200Response
• VultrRuby::GetInstanceIsoStatus200Response
• VultrRuby::GetInstanceIsoStatus200ResponseIsoStatus
• VultrRuby::GetInstanceNeighbors200Response
• VultrRuby::GetInstanceUpgrades200Response
• VultrRuby::GetInstanceUpgrades200ResponseUpgrades
• VultrRuby::GetInstanceUserdata200Response
• VultrRuby::GetInstanceUserdata200ResponseUserData
• VultrRuby::GetInvoice200Response
• VultrRuby::GetInvoiceItems200Response
• VultrRuby::GetInvoiceItems200ResponseInvoiceItemsInner
• VultrRuby::GetInvoiceItems200ResponseMeta
• VultrRuby::GetInvoiceItems200ResponseMetaLinks
• VultrRuby::GetIpv4Baremetal200Response
• VultrRuby::GetIpv6Baremetal200Response
• VultrRuby::GetKubernetesAvailableUpgrades200Response
• VultrRuby::GetKubernetesClustersConfig200Response
• VultrRuby::GetKubernetesResources200Response
• VultrRuby::GetKubernetesResources200ResponseResources
• VultrRuby::GetKubernetesResources200ResponseResourcesBlockStorageInner
• VultrRuby::GetKubernetesResources200ResponseResourcesLoadBalancerInner
• VultrRuby::GetKubernetesVersions200Response
• VultrRuby::GetLoadBalancerForwardingRule200Response
• VultrRuby::GetNetwork200Response
• VultrRuby::GetNodepools200Response
• VultrRuby::GetReservedIp200Response
• VultrRuby::GetSnapshot200Response
• VultrRuby::GetSshKey200Response
• VultrRuby::GetStartupScript200Response
• VultrRuby::GetVpc200Response
• VultrRuby::GetVpc2200Response
• VultrRuby::HaltBaremetalsRequest
• VultrRuby::HaltInstancesRequest
• VultrRuby::Instance
• VultrRuby::InstanceV6NetworksInner
• VultrRuby::InstanceVpc2
• VultrRuby::Invoice
• VultrRuby::Iso
• VultrRuby::IsoPublic
• VultrRuby::ListAdvancedOptions200Response
• VultrRuby::ListApplications200Response
• VultrRuby::ListAvailablePlansRegion200Response
• VultrRuby::ListAvailableVersions200Response
• VultrRuby::ListBackups200Response
• VultrRuby::ListBaremetalVpc2200Response
• VultrRuby::ListBaremetals200Response
• VultrRuby::ListBillingHistory200Response
• VultrRuby::ListBlocks200Response
• VultrRuby::ListConnectionPools200Response
• VultrRuby::ListDatabaseDbs200Response
• VultrRuby::ListDatabasePlans200Response
• VultrRuby::ListDatabaseUsers200Response
• VultrRuby::ListDatabases200Response
• VultrRuby::ListDnsDomainRecords200Response
• VultrRuby::ListDnsDomains200Response
• VultrRuby::ListFirewallGroupRules200Response
• VultrRuby::ListFirewallGroups200Response
• VultrRuby::ListInstanceIpv6Reverse200Response
• VultrRuby::ListInstanceIpv6Reverse200ResponseReverseIpv6sInner
• VultrRuby::ListInstancePrivateNetworks200Response
• VultrRuby::ListInstanceVpc2200Response
• VultrRuby::ListInstanceVpcs200Response
• VultrRuby::ListInstances200Response
• VultrRuby::ListInvoices200Response
• VultrRuby::ListIsos200Response
• VultrRuby::ListKubernetesClusters200Response
• VultrRuby::ListLoadBalancerForwardingRules200Response
• VultrRuby::ListLoadBalancers200Response
• VultrRuby::ListMaintenanceUpdates200Response
• VultrRuby::ListMetalPlans200Response
• VultrRuby::ListNetworks200Response
• VultrRuby::ListObjectStorageClusters200Response
• VultrRuby::ListObjectStorages200Response
• VultrRuby::ListOs200Response
• VultrRuby::ListPlans200Response
• VultrRuby::ListPublicIsos200Response
• VultrRuby::ListRegions200Response
• VultrRuby::ListRegistries200Response
• VultrRuby::ListRegistryPlans200Response
• VultrRuby::ListRegistryPlans200ResponsePlans
• VultrRuby::ListRegistryRegions200Response
• VultrRuby::ListRegistryRepositories200Response
• VultrRuby::ListReservedIps200Response
• VultrRuby::ListServiceAlerts200Response
• VultrRuby::ListServiceAlertsRequest
• VultrRuby::ListSnapshots200Response
• VultrRuby::ListSshKeys200Response
• VultrRuby::ListStartupScripts200Response
• VultrRuby::ListSubaccounts200Response
• VultrRuby::ListUsers200Response
• VultrRuby::ListVpc2200Response
• VultrRuby::ListVpcs200Response
• VultrRuby::Loadbalancer
• VultrRuby::LoadbalancerFirewallRule
• VultrRuby::LoadbalancerFirewallRulesInner
• VultrRuby::LoadbalancerForwardRulesInner
• VultrRuby::LoadbalancerGenericInfo
• VultrRuby::LoadbalancerGenericInfoStickySessions
• VultrRuby::LoadbalancerHealthCheck
• VultrRuby::Meta
• VultrRuby::MetaLinks
• VultrRuby::Network
• VultrRuby::NodepoolInstances
• VultrRuby::Nodepools
• VultrRuby::ObjectStorage
• VultrRuby::Os
• VultrRuby::PatchReservedIpsReservedIpRequest
• VultrRuby::Plans
• VultrRuby::PlansMetal
• VultrRuby::PostFirewallsFirewallGroupIdRules201Response
• VultrRuby::PostFirewallsFirewallGroupIdRulesRequest
• VultrRuby::PostInstancesInstanceIdIpv4ReverseDefaultRequest
• VultrRuby::PrivateNetworks
• VultrRuby::PutSnapshotsSnapshotIdRequest
• VultrRuby::RebootInstancesRequest
• VultrRuby::RegenerateObjectStorageKeys201Response
• VultrRuby::RegenerateObjectStorageKeys201ResponseS3Credentials
• VultrRuby::Region
• VultrRuby::Registry
• VultrRuby::RegistryDockerCredentials
• VultrRuby::RegistryDockerCredentialsAuths
• VultrRuby::RegistryDockerCredentialsAuthsRegistryRegionNameVultrcrCom
• VultrRuby::RegistryKubernetesDockerCredentials
• VultrRuby::RegistryKubernetesDockerCredentialsData
• VultrRuby::RegistryKubernetesDockerCredentialsMetadata
• VultrRuby::RegistryMetadata
• VultrRuby::RegistryMetadataSubscription
• VultrRuby::RegistryMetadataSubscriptionBilling
• VultrRuby::RegistryPlan
• VultrRuby::RegistryRegion
• VultrRuby::RegistryRepository
• VultrRuby::RegistryStorage
• VultrRuby::RegistryUser
• VultrRuby::ReinstallBaremetalRequest
• VultrRuby::ReinstallInstanceRequest
• VultrRuby::ReservedIp
• VultrRuby::RestoreInstance202Response
• VultrRuby::RestoreInstance202ResponseStatus
• VultrRuby::RestoreInstanceRequest
• VultrRuby::SetDatabaseUserAclRequest
• VultrRuby::Snapshot
• VultrRuby::Ssh
• VultrRuby::StartInstancesRequest
• VultrRuby::StartKubernetesClusterUpgradeRequest
• VultrRuby::StartMaintenanceUpdates200Response
• VultrRuby::StartVersionUpgrade200Response
• VultrRuby::StartVersionUpgradeRequest
• VultrRuby::Startup
• VultrRuby::Subaccount
• VultrRuby::UpdateAdvancedOptionsRequest
• VultrRuby::UpdateBaremetalRequest
• VultrRuby::UpdateBlockRequest
• VultrRuby::UpdateConnectionPoolRequest
• VultrRuby::UpdateDatabaseRequest
• VultrRuby::UpdateDatabaseUserRequest
• VultrRuby::UpdateDnsDomainRecordRequest
• VultrRuby::UpdateDnsDomainRequest
• VultrRuby::UpdateDnsDomainSoaRequest
• VultrRuby::UpdateFirewallGroupRequest
• VultrRuby::UpdateInstanceRequest
• VultrRuby::UpdateKubernetesClusterRequest
• VultrRuby::UpdateLoadBalancerRequest
• VultrRuby::UpdateLoadBalancerRequestHealthCheck
• VultrRuby::UpdateNetworkRequest
• VultrRuby::UpdateNodepoolRequest
• VultrRuby::UpdateNodepoolRequest1
• VultrRuby::UpdateObjectStorageRequest
• VultrRuby::UpdateRegistryRequest
• VultrRuby::UpdateRepositoryRequest
• VultrRuby::UpdateSshKeyRequest
• VultrRuby::UpdateStartupScriptRequest
• VultrRuby::UpdateUserRequest
• VultrRuby::UpdateVpc2Request
• VultrRuby::UpdateVpcRequest
• VultrRuby::User
• VultrRuby::UserUser
• VultrRuby::ViewMigrationStatus200Response
• VultrRuby::VkeCluster
• VultrRuby::Vpc
• VultrRuby::Vpc2

Authentication schemes defined for the API:

• Type: Bearer authentication