Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Oracle Private Cloud Appliance Compute Enclave
• Configure Your User Account
• Use the REST API

Tasks

• Autoscaling
  • Change an AutoScaling Configuration Compartment
  • Create an AutoScaling Configuration
  • Create an AutoScaling Policy
  • Delete an AutoScaling Configuration
  • Delete an AutoScaling Policy
  • Get an AutoScaling Configuration
  • Get an AutoScaling Policy
  • List AutoScaling Configurations
  • List AutoScaling Policies
  • Update an AutoScaling Configuration
  • Update an AutoScaling Policy
• Block Storage
  • Block Volumes
    • Change a Volume Backup Compartment
    • Change a Volume Compartment
    • Change a Volume Group Backup Compartment
    • Change a Volume Group Compartment
    • Create a Volume
    • Create a Volume Backup
    • Create a Volume Backup Copy
    • Create a Volume Backup Policy
    • Create a Volume Backup Policy Assignment
    • Create a Volume Group
    • Create a Volume Group Backup
    • Delete a Volume
    • Delete a Volume Backup
    • Delete a Volume Backup Policy
    • Delete a Volume Backup Policy Assignment
    • Delete a Volume Group
    • Delete a Volume Group Backup
    • Get a Volume
    • Get a Volume Backup
    • Get a Volume Backup Policy
    • Get a Volume Backup Policy Asset Assignment
    • Get a Volume Backup Policy Assignment
    • Get a Volume Group
    • Get a Volume Group Backup
    • List Volume Backup Policies
    • List Volume Backups
    • List Volume Group Backups
    • List Volume Groups
    • List Volumes
    • Update a Volume
    • Update a Volume Backup
    • Update a Volume Backup Policy
    • Update a Volume Group
    • Update a Volume Group Backup
  • Boot Volumes
    • Change a Boot Volume Backup Compartment
    • Change a Boot Volume Compartment
    • Create a Boot Volume
    • Create a Boot Volume Backup
    • Delete a Boot Volume
    • Delete a Boot Volume Backup
    • Get a Boot Volume
    • Get a Boot Volume Backup
    • List Boot Volume Backups
    • List Boot Volumes
    • Update a Boot Volume
    • Update a Boot Volume Backup
• blockstorage
  • GetBlockVolumeReplica
  • GetBootVolumeReplica
  • Gets information for the specified volume group replica.
  • ListBlockVolumeReplicas
  • ListBootVolumeReplicas
  • Lists the volume group replicas in the specified compartment.
• Compute
  • Change an Instance Compartment
  • Export an Instance
  • Get an Instance
  • Launch an Instance
  • List Instance Devices
  • List Instances
  • List Shapes
  • Perform Instance Action
  • Terminate an Instance
  • Update an Instance
  • Console Connections
    • Create an Instance Console Connection
    • Delete an Instance Console Connection
    • Get an Instance Console Connection
    • List Instance Console Connections
    • Update an Instance Console Connection
  • Images
    • Add an Image Shape Compatibility Entry
    • Change an Image Compartment
    • Create an Image
    • Delete an Image
    • Export an Image
    • Get an Image
    • Get an Image Shape Compatibility Entry
    • List Image Shape Compatibility Entries
    • List Images
    • Remove an Image Shape Compatibility Entry
    • Update an Image
  • Instance Backups
    • Delete an Instance Backup
    • Get an Instance Backup
    • ImportInstanceBackup
    • List Instance Backups
  • VNICs
    • Attach VNIC
    • Detach VNIC
    • Get a VNIC Attachment
    • List VNIC Attachments
  • Volumes
    • Attach a Volume
    • Detach a Volume
    • Get a Volume Attachment
    • List Volume Attachments
    • Boot Volumes
      • Attach Boot Volume
      • Detach a Boot Volume
      • Get a Boot Volume Attachment
      • List Boot Volume Attachments
• Compute Management
  • Attach a Load Balancer
  • Attach an Instance Pool Instance
  • Change an Instance Configuration Compartment
  • Create an Instance Configuration
  • Create an Instance Pool
  • Delete an Instance Configuration
  • Detach a Load Balancer
  • Detach an Instance Pool Instance
  • Get a Load Balancer Attachment
  • Get an Instance Configuration
  • Get an Instance Pool
  • Get an Instance Pool Instance
  • Launch an Instance Configuration
  • List Instance Configurations
  • List Instance Pool Instances
  • List Instance Pools
  • Reset an Instance Pool
  • Softreset an Instance Pool
  • Softstop an Instance Pool
  • Start an Instance Pool
  • Stop an Instance Pool
  • Terminate an Instance Pool
  • Update an Instance Configuration
  • Update an Instance Pool
• container
  • Get a list of Containers in a compartment
  • Get a single Container.
  • Retrieve recent log from a container.
  • Updates a Container.
• Container Engine
  • DeleteWorkRequest
  • GetWorkRequest
  • ListWorkRequestErrors
  • Clusters
    • CreateCluster
    • CreateKubeconfig
    • DeleteCluster
    • GetCluster
    • GetClusterOptions
    • ListClusters
    • UpdateCluster
    • UpdateClusterEndpointConfig
  • Node Pools
    • CreateNodePool
    • DeleteNode
    • DeleteNodePool
    • GetNodePool
    • GetNodePoolOptions
    • ListNodePools
    • UpdateNodePool
• containerEngine
  • Disable addon for a cluster.
  • Get addon details.
  • Get list of supported addons for a specific kubernetes version.
  • Install addon for a cluster.
  • List addon for a cluster.
  • Update addon details for a cluster.
• containerInstance
  • Creates a new ContainerInstance
  • Delete a provisioned ContainerInstance
  • Get ContainerInstance
  • Gets a list of all ContainerInstances in a compartment
  • Moves a resource into a different compartment.
  • Restart container instance.
  • Starts an inactive container instance.
  • Stops an active container instance.
  • Update the ContainerInstance identified by the id
• containerInstanceShape
  • Lists the shapes that can be used to create container instances.
• DNS
  • Create a new attachment between a steering policy and a domain, giving the policy permission to answer queries for the specified domain
  • Create a new steering policy in the specified compartment
  • Creates a new TSIG key in the specified compartment
  • Creates a new zone in the specified compartment
  • Delete the specified TSIG key
  • Deletes all records at the specified zone and domain
  • Deletes all records in the specified RRSet
  • Deletes the specified steering policy
  • Deletes the specified steering policy attachment
  • Deletes the specified zone and all its steering policy attachments
  • Get a list of all steering policies in the specified compartment
  • Get a list of all TSIG keys in the specified compartment
  • Get information about the specified steering policy
  • Get information about the specified steering policy attachment
  • Get information about the specified TSIG key
  • Get the requested zone's zone file
  • Gets a list of all records at the specified zone and domain
  • Gets a list of all records in the specified RRSet
  • Gets a list of all zones in the specified compartment
  • Gets all records in the specified zone
  • Gets information about the specified zone, including its creation date, zone type, and serial
  • List the steering policy attachments in the specified compartment
  • Move a steering policy into a different compartment
  • Move a TSIG key into a different compartment
  • Moves a zone into a different compartment
  • Replaces records in the specified RRSet
  • Replaces records in the specified zone at a domain with the records specified in the request body
  • Replaces records in the specified zone with the records specified in the request body
  • Update the configuration of the specified steering policy
  • Update the specified steering policy attachment with your new information
  • Update the specified TSIG key
  • Update the zone with the specified information
  • Updates a collection of records in the specified zone
  • Updates records in the specified RRSet
  • Updates records in the specified zone at a domain
• File Storage
  • Change a File System Compartment
  • Change a Mount Target Compartment
  • Create a File System
  • Create a Mount Target
  • Create a Snapshot
  • Create an Export
  • Delete a File System
  • Delete a Mount Target
  • Delete a Snapshot
  • Delete an Export
  • Get a File System
  • Get a Mount Target
  • Get a Snapshot
  • Get an Export
  • Get an Export Set
  • List Export Sets
  • List Exports
  • List File Systems
  • List Lock Owners
  • List Mount Targets
  • List Snapshots
  • Update a File System
  • Update a Mount Target
  • Update a Snapshot
  • Update an Export
  • Update an Export Set
• fileStorage
  • ChangeReplicationCompartment
  • ChangeReplicationTargetCompartment
  • CheckReconciliation
  • CreateReplication
  • CreateReplicationTarget
  • DeleteReplication
  • DeleteReplicationTarget
  • EstimateReplication
  • GetReplication
  • GetReplicationTarget
  • GetReplicationTargetProgress
  • ListReplications
  • ListReplicationTargets
  • ReplicationFail
  • ReplicationStatusUpdate
  • ReplicationTargetDelete
  • ReplicationTargetFail
  • ReplicationTargetFileSystemGet
  • ReplicationTargetGet
  • ReplicationTargetStatusUpdate
  • ReserveTargetNum
  • RestartStuckDelta
  • SourceTriggeredDelete
  • UpdateReplication
  • UpdateReplicationTarget
• Identity
  • List Availability Domains
  • List Fault Domains
  • List Region Subscriptions
  • List Regions
  • Compartments
    • Create a Compartment
    • Delete a Compartment
    • Get a Compartment
    • Get a Tenancy
    • List Compartments
    • MoveCompartment
    • Update a Compartment
  • Dynamic Groups
    • Create a Dynamic Group
    • Delete a Dynamic Group
    • Get a Dynamic Group
    • List Dynamic Groups
    • Update a Dynamic Group
  • Federating
    • Create an Identity Provider
    • Create an IDP Group Mapping
    • Delete an Identity Provider
    • Delete an IDP Group Mapping
    • Get an Identity Provider
    • Get an IDP Group Mapping
    • List Identity Providers
    • List IDP Group Mappings
    • Update an Identity Provider
    • Update an IDP Group Mapping
  • Groups
    • Add User to Group
    • Create a Group
    • Delete a Group
    • Get a Group
    • Get User Group Membership
    • List Groups
    • List My Groups
    • List User Group Memberships
    • Remove User from Group
    • Update a Group
  • Policies
    • Create a Policy
    • Delete a Policy
    • Get a Policy
    • List Policies
    • Update a Policy
  • Tags
    • Assemble Effective Tag Set
    • ChangeTagNamespaceCompartment
    • Create a Tag
    • Create a Tag Default
    • Create a Tag Namespace
    • Delete a Tag
    • Delete a Tag Default
    • Delete a Tag Namespace
    • Get a Tag
    • Get a Tag Default
    • Get a Tag Namespace
    • Get a Tagging Work Request
    • List Cost Tracking Tags
    • List Tag Defaults
    • List Tag Namespaces
    • List Tagging Work Request Errors
    • List Tagging Work Requests
    • List Tags
    • Update a Tag
    • Update a Tag Default
    • Update a Tag Namespace
  • Users
    • Add User to Group
    • Create a Session
    • Create a User
    • Create or Reset UI Password
    • Delete a Session
    • Delete a User
    • Delete an API Key
    • Get a User
    • Get User Group Membership
    • List API Keys
    • List My Groups
    • List User Group Memberships
    • List Users
    • Remove User from Group
    • Update a Password
    • Update a User
    • Update User State
    • Upload an API Key
• Kubernetes Engine
  • List Work Requests
• Limits
  • Get a Limit Resource Availability
  • Get a Service Resource Limit Definitions
  • Get a Service Resource Limit Values
  • List Limits Services
• Load Balancers
  • LBaaS
    • Change a Load Balancer Compartment
    • Create a Backend
    • Create a Backend Set
    • Create a Certificate
    • Create a Hostname
    • Create a Listener
    • Create a Load Balancer
    • Create a Path Route Set
    • Create an SSL Cipher Suite
    • Delete a Backend
    • Delete a Backend Set
    • Delete a Certificate
    • Delete a Hostname
    • Delete a Listener
    • Delete a Load Balancer
    • Delete a Path Route Set
    • Delete an SSL Cipher Suite
    • Get a Backend
    • Get a Backend Set
    • Get a Health Checker
    • Get a Hostname
    • Get a Load Balancer
    • Get a Path Route Set
    • Get a Work Request
    • Get an SSL Cipher Suite
    • Get Backend Server Health
    • Get Backend Set Health
    • Get Load Balancer Health
    • List Backend Sets
    • List Backends
    • List Certificates
    • List Hostnames
    • List Load Balancer Healths
    • List Load Balancers
    • List Path Route Sets
    • List Policies
    • List Protocols
    • List Shapes
    • List SSL Cipher Suites
    • List Work Requests
    • Update a Backend
    • Update a Backend Set
    • Update a Health a Checker
    • Update a Hostname
    • Update a Listener
    • Update a Load Balancer
    • Update a Path Route Set
    • Update an SSL Cipher Suite
    • Update Network Security Groups
  • Network Load Balancer
    • ChangeNetworkLoadBalancerCompartment
    • CreateBackend
    • CreateBackendSet
    • CreateListener
    • CreateNetworkLoadBalancer
    • DeleteBackend
    • DeleteBackendSet
    • DeleteListener
    • DeleteNetworkLoadBalancer
    • Get a Work Request Status
    • GetBackend
    • GetBackendHealth
    • GetBackendSet
    • GetBackendSetHealth
    • GetHealthChecker
    • GetListener
    • GetNetworkLoadBalancer
    • GetNetworkLoadBalancerHealth
    • List Work Requests
    • ListBackends
    • ListBackendSets
    • ListListeners
    • ListNetworkLoadBalancerHealths
    • ListNetworkLoadBalancers
    • ListNetworkLoadBalancersPolicies
    • ListNetworkLoadBalancersProtocols
    • ListWorkRequestErrors
    • UpdateBackend
    • UpdateBackendSet
    • UpdateHealthChecker
    • UpdateListener
    • UpdateNetworkLoadBalancer
    • UpdateNetworkSecurityGroups
• manual
  • Create a Session
  • Delete a Session
  • Delete an Instance Backup
  • Export an Instance
  • Get an Instance Backup
  • ImportInstanceBackup
  • List Instance Backups
  • List My Groups
  • Update a Password
• Networking
  • DHCP
    • Change a DHCP Options Compartment
    • Create DHCP Options
    • Delete DHCP Options
    • Get DHCP Options
    • List DHCP Options
    • Update DHCP Options
  • Dynamic Routing Gateways
    • Change a DRG Compartment
    • Create a DRG
    • Create a DRG Attachment
    • Delete a DRG
    • Delete a DRG Attachment
    • Get a DRG
    • Get a DRG Attachment
    • Get DRG Redundancy Status
    • List DRG Attachments
    • List DRGs
    • Update a DRG
    • Update a DRG Attachment
  • Internet Gateways
    • Change an Internet Gateway Compartment
    • Create an Internet Gateway
    • Delete an Internet Gateway
    • Get an Internet Gateway
    • List Internet Gateways
    • Update an Internet Gateway
  • Local Peering Gateways
    • Change a Local Peering Gateway Compartment
    • Connect Local Peering Gateways
    • Create a Local Peering Gateway
    • Delete a Local Peering Gateway
    • Get a Local Peering Gateway
    • List Local Peering Gateways
    • Update a Local Peering Gateway
  • NAT Gateways
    • Change a NAT Gateway Compartment
    • Create a NAT Gateway
    • Delete a NAT Gateway
    • Get a NAT Gateway
    • List NAT Gateways
    • Update a NAT Gateway
  • Private IPs
    • Create a Private IP
    • Delete a Private IP
    • Get a Private IP
    • List Private IPs
    • Update a Private IP
  • Public IPs
    • Change a Public IP Compartment
    • Create a Public IP
    • Delete a Public IP
    • Get a Public IP
    • Get a Public IP By IP Address
    • Get a Public IP By Private IP ID
    • List Public IPs
    • Update a Public IP
  • Route Tables
    • Change a Route Table Compartment
    • Create a Route Table
    • Delete a Route Table
    • Get a Route Table
    • List Route Tables
    • Update a Route Table
  • Security Groups
    • Add Network Security Group Security Rules
    • Change a Network Security Group Compartment
    • Create a Network Security Group
    • Delete a Network Security Group
    • Get a Network Security Group
    • List Network Security Group Security Rules
    • List Network Security Group VNICs
    • List Network Security Groups
    • Remove Network Security Group Security Rules
    • Update a Network Security Group
    • Update Network Security Group Security Rules
  • Security Lists
    • Change a Security List Compartment
    • Create a Security List
    • Delete a Security List
    • Get a Security List
    • List Security Lists
    • Update a Security List
  • Service Gateways
    • Attach a Service
    • Change a Service Gateway Compartment
    • Create a Service Gateway
    • Delete a Service Gateway
    • Detach a Service
    • Get a Service
    • Get a Service Gateway
    • List Service Gateways
    • List Services
    • Update a Service Gateway
  • Subnets
    • Change a Subnet Compartment
    • Create a Subnet
    • Delete a Subnet
    • Get a Subnet
    • List Subnets
    • Update a Subnet
  • VCNs
    • Change a VCN Compartment
    • Create a VCN
    • Delete a VCN
    • Get a VCN
    • List VCNs
    • Update a VCN
  • VNICs
    • Get a VNIC
    • Update a VNIC
• Object Storage
  • CreateBucket
  • GetNamespace
  • GetNamespaceMetadata
  • ListBuckets
  • ListObjects
• Work Requests
  • GetWorkRequest
  • ListWorkRequestErrors
  • ListWorkRequests
• workRequest
  • GET Work Request Status
  • List Work Requests
  • Lists work request errors
  • Lists work request logs