Oracle Cloud Infrastructure Documentation

SDK for Ruby

The Oracle Cloud Infrastructure SDK for Ruby enables you to write code to manage Oracle Cloud Infrastructure resources.
Note

The Oracle Cloud Infrastructure SDK for Ruby currently supports Ruby versions 2.6 and 2.7.
Note

This project is no longer being actively developed by Oracle. We will continue to address security vulnerabilities for the foreseeable future, and will respond to questions on github, but have no plans to introduce any new functionality, and may not be able to address any non-security related issues. We encourage developers to migrate to other OCI SDKs, and developers may fork the project and enhance it as they desire.

This SDK and sample are dual-licensed under the Universal Permissive License 1.0 and the Apache License 2.0; third-party content is separately licensed as described in the code.

Download: The SDK for Ruby is available on GitHub or RubyGems.

Documentation: SDK for Ruby documentation.

Tip

The SDK for Ruby is pre-installed on the Oracle Linux Cloud Developer platform image. For more information, see Oracle Linux Cloud Developer.

Installing with DNF

If you're using Oracle Linux 7 or 8, you can use DNF to install the OCI SDK for Ruby.

The following example shows how to use DNF to install the OCI SDK for Ruby 2.7 on Oracle Linux 7:

dnf module reset ruby
dnf module enable ruby:2.7
dnf install oci-ruby-sdk
export GEM_PATH="/usr/share/gems:`gem env gempath`"

The following example shows how to use yum to install the OCI SDK for Ruby 2.6 on Oracle Linux 8:

dnf module reset ruby
dnf module enable ruby:2.6
dnf install oci-ruby-sdk
export GEM_PATH="/usr/share/gems:`gem env gempath`"

Services Supported

  • Access Governance
  • Account Management
  • AI Anomaly Detection
  • AI Language
  • AI Speech
  • AI Vision
  • Analytics Cloud
  • Announcements
  • Application Dependency Management
  • Application Management
  • API Gateway
  • Application Performance Monitoring
  • Audit
  • Autonomous Recovery
  • Autoscaling (Compute)
  • Bastion
  • Big Data Service
  • Blockchain Platform
  • Budgets
  • Build
  • Caching
  • Certificates
  • Cloud Bridge
  • Cloud Guard
  • Cloud Migrations
  • Cluster Placement Groups
  • Compute Cloud@Customer
  • Connector Hub
  • Console Dashboard Service
  • Kubernetes Engine
  • Content Management
  • Core Services (Networking, Compute, Block Volume)
  • Data Catalog
  • Data Flow
  • Data Integration
  • Data Labeling
  • Data Safe
  • Data Science
  • Data Transfer
  • Database
  • Database Migration
  • Database Management
  • Database Tools
  • Devops
  • Digital Assistant
  • Digital Media
  • Disaster Recovery
  • DNS
  • Document Understanding
  • Email Delivery
  • Enterprise Manager Warehouse
  • Events
  • Exadata Fleet Update
  • File Storage
  • Functions
  • Fusion Apps as a Service
  • Generative AI
  • Generative AI Inference
  • Generic Artifacts
  • Globally Distributed Database
  • GoldenGate
  • Governance Rules
  • Health Checks
  • IAM
  • Identity Domains
  • Integration Generation 2
  • Java Management
  • Java Management Service Downloads
  • Key Management (for the Vault service)
  • License Manager
  • Limits
  • Logging
  • Logging Analytics
  • Logging Search
  • Logging Ingestion
  • Load Balancer
  • Management Agent Cloud
  • Management Dashboard
  • Marketplace
  • Marketplace Publisher
  • Monitoring
  • HeatWave
  • Network Firewall
  • Network Load Balancing
  • Network Monitoring
  • Networking Topology
  • NoSQL Database Cloud
  • Notifications
  • Object Storage
  • OCI Control Center
  • OCI Registry
  • OneSubscription
  • Operations Insights
  • Operator Access Control
  • Optimizer
  • Organizations
  • OS Management
  • PostgreSQL
  • Process Automation
  • Queue Service
  • Quotas
  • Resource Manager
  • Roving Edge Infrastructure
  • Search
  • Secret Management (for the Vault service)
  • Secure Desktops
  • Service Catalog
  • Service Mesh
  • Source Code Management
  • Stack Monitoring
  • Streaming
  • Support Management
  • Threat Intelligence
  • Usage
  • Visual Builder
  • VMWare Solution
  • Vulnerability Scanning
  • Web Application Acceleration and Security
  • Work Requests (Compute, Database)