SDK for TypeScript and JavaScript

The Oracle Cloud Infrastructure SDK for TypeScript and JavaScript enables you to write code to manage Oracle Cloud Infrastructure resources.

This SDK and sample is 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: GitHub or NPM.

Tip

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

Requirements

To use the SDK for TypeScript and JavaScript, you must have the following:

  • An Oracle Cloud Infrastructure account.
  • A user created in that account, in a group with a policy that grants the desired permissions. This can be a user for yourself, or another person/system that needs to call the API. For an example of how to set up a new user, group, compartment, and policy, see Adding Users. For a list of typical policies you may want to use, see Common Policies.
  • A key pair used for signing API requests, with the public key uploaded to Oracle. Only the user calling the API should be in possession of the private key. For more information, see Getting Started.

Services Supported

  • Access Governance
  • Account Management
  • AI Anomaly Detection
  • AI Language
  • AI Speech
  • AI Vision
  • Analytics Cloud
  • Announcements
  • API Gateway
  • Application Dependency Management
  • Application Management
  • Application Performance Monitoring
  • Audit
  • Autonomous Recovery
  • Autoscaling (Compute)
  • Bastion
  • Big Data Service
  • Blockchain Platform
  • Budgets
  • Build
  • OCI Cache
  • Certificates
  • Cloud Bridge
  • Cloud Migrations
  • Compute Cloud@Customer
  • Compute Instance Agent (Oracle Cloud Agent)
  • Console Dashboard
  • Kubernetes Engine
  • Container Instances
  • Content Management
  • Core Services (Networking, Compute, Block Volume)
  • Cloud Guard
  • Cloud Migrations
  • Connector Hub
  • Data Catalog
  • Data Flow
  • Data Integration
  • Data Labeling
  • Data Safe
  • Data Science
  • Data Transfer
  • Database
  • Database Management
  • Database Migration
  • Database Tools
  • Delegate Access Control
  • Demand Signal
  • DevOps
  • Digital Assistant
  • Digital Media
  • Disaster Recovery
  • DNS
  • Document Understanding
  • Email Delivery
  • Enterprise Manager Warehouse
  • Events
  • Exadata Fleet Update
  • File Storage
  • Fleet Application Management
  • Functions
  • Fusion Apps as a Service
  • Generative AI
  • Generative AI Agent
  • 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
  • Load Balancer
  • Logging
  • Logging Analytics
  • Logging Search
  • Logging Ingestion
  • Managed Access
  • Management Agent Cloud
  • Management Dashboard
  • Marketplace
  • Marketplace Private Offer
  • Monitoring
  • HeatWave
  • Network Firewall
  • Network Load Balancing
  • Network Monitoring
  • Networking Topology
  • NoSQL Database Cloud
  • Notifications
  • Object Storage
  • OCI Control Center
  • OCI Registry
  • OCI Secure Desktops
  • OneSubscription
  • Operations Insights
  • Operator Access Control
  • Optimizer
  • Organizations
  • OS Management
  • OS Management Hub
  • PostgreSQL
  • Process Automation
  • Publisher
  • Queue Service
  • Quotas
  • Resource Manager
  • Resource Scheduler
  • Roving Edge Infrastructure
  • Search
  • Secret Managment (for the Vault)
  • Secure Desktops
  • Security Attribute
  • Service Catalog
  • Source Code Management
  • Service Mesh
  • Stack Monitoring
  • Streaming
  • Support Management
  • Threat Intelligence
  • Usage
  • Visual Builder
  • VMWare Solution
  • Vulnerability Scanning
  • Web Application Acceleration and Security
  • Work Requests (Compute, Database)
  • Zero Trust Packet Routing

Versions Supported

The SDK for TypeScript and JavaScript currently supports NodeJS version 14.x, 16.x, 20.x, and TypeScript version 4.1.x.

NodeJS & Browser Support

The SDK for TypeScript and JavaScript currently supports NodeJS but does not have browser support.

Contact Us

Contributions

Got a fix for a bug or a new feature you'd like to contribute? The SDK is open source and accepting pull requests on GitHub.

Notifications

To be notified when a new version of the SDK for TypeScript and JavaScript is released, subscribe to the Atom feed.

Questions or Feedback