How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Platforms Compute API

The compute API from Oracle Platforms — 82 operation(s) for compute.

Oracle Platforms Compute API is one of 11 APIs that Oracle Platforms publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Compute. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, and pricing.

This API exposes 130 operations across 82 paths, and defines 190 schemas. It is described by OpenAPI 3.2.0, at version 20160918.

Requests are made against a single base URL, /20160918.

130 operations 82 paths 190 schemas 16 DELETE64 GET34 POST16 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20160918
Base URL
https://iaas.{region}.oraclecloud.com
License
Oracle Corporation
Resource Areas
1

Paths & Operations 130

Across 82 paths, the API surfaces 130 operations — 16 DELETE, 64 GET, 34 POST, 16 PUT. Each is listed below with its method, path, parameters, and response codes.

compute 130
GET
/appCatalogListings
ListAppCatalogListings
ListAppCatalogListings 6 params → 200400401404500default
GET
/appCatalogListings/{listingId}
GetAppCatalogListing
GetAppCatalogListing 1 param → 200401404500default
GET
/appCatalogListings/{listingId}/resourceVersions
ListAppCatalogListingResourceVersions
ListAppCatalogListingResourceVersions 4 params → 200400401404500default
GET
/appCatalogListings/{listingId}/resourceVersions/{resourceVersion}
GetAppCatalogListingResourceVersion
GetAppCatalogListingResourceVersion 2 params → 200401404500default
GET
/appCatalogListings/{listingId}/resourceVersions/{resourceVersion}/agreements
GetAppCatalogListingAgreements
GetAppCatalogListingAgreements 2 params → 200401404500default
DELETE
/appCatalogSubscriptions
DeleteAppCatalogSubscription
DeleteAppCatalogSubscription 3 params → 204401404500default
GET
/appCatalogSubscriptions
ListAppCatalogSubscriptions
ListAppCatalogSubscriptions 6 params → 200400401404500default
POST
/appCatalogSubscriptions
CreateAppCatalogSubscription
CreateAppCatalogSubscription 1 param body → 200400401404500default
GET
/bootVolumeAttachments/
ListBootVolumeAttachments
ListBootVolumeAttachments 6 params → 200400401404500default
POST
/bootVolumeAttachments/
AttachBootVolume
AttachBootVolume 1 param body → 200400401404409500default
DELETE
/bootVolumeAttachments/{bootVolumeAttachmentId}
DetachBootVolume
DetachBootVolume 2 params → 204401404409412500default
GET
/bootVolumeAttachments/{bootVolumeAttachmentId}
GetBootVolumeAttachment
GetBootVolumeAttachment 1 param → 200401404500default
POST
/computeCapacityReports
CreateComputeCapacityReport
CreateComputeCapacityReport 2 params body → 200400401404429500default
GET
/computeCapacityReservationInstanceShapes
ListComputeCapacityReservationInstanceShapes
ListComputeCapacityReservationInstanceShapes 8 params → 200400401404429500default
GET
/computeCapacityReservations
ListComputeCapacityReservations
ListComputeCapacityReservations 9 params → 200400401404429500default
POST
/computeCapacityReservations
CreateComputeCapacityReservation
CreateComputeCapacityReservation 2 params body → 201400401404409429500default
DELETE
/computeCapacityReservations/{capacityReservationId}
DeleteComputeCapacityReservation
DeleteComputeCapacityReservation 3 params → 202401404409412429500default
GET
/computeCapacityReservations/{capacityReservationId}
GetComputeCapacityReservation
GetComputeCapacityReservation 2 params → 200401404429500default
PUT
/computeCapacityReservations/{capacityReservationId}
UpdateComputeCapacityReservation
UpdateComputeCapacityReservation 3 params body → 202400401404409412429500
POST
/computeCapacityReservations/{capacityReservationId}/actions/changeCompartment
ChangeComputeCapacityReservationCompartment
ChangeComputeCapacityReservationCompartment 4 params body → 202400401404409412429500
GET
/computeCapacityReservations/{capacityReservationId}/instances
ListComputeCapacityReservationInstances
ListComputeCapacityReservationInstances 8 params → 200400401404429500default
GET
/computeCapacityTopologies
ListComputeCapacityTopologies
ListComputeCapacityTopologies 8 params → 200400401404429500default
POST
/computeCapacityTopologies
CreateComputeCapacityTopology
CreateComputeCapacityTopology 2 params body → 201400401404409429500default
DELETE
/computeCapacityTopologies/{computeCapacityTopologyId}
DeleteComputeCapacityTopology
DeleteComputeCapacityTopology 3 params → 202401404409412429500default
GET
/computeCapacityTopologies/{computeCapacityTopologyId}
GetComputeCapacityTopology
GetComputeCapacityTopology 2 params → 200400401404429500default
PUT
/computeCapacityTopologies/{computeCapacityTopologyId}
UpdateComputeCapacityTopology
UpdateComputeCapacityTopology 3 params body → 202400401404409412429500
POST
/computeCapacityTopologies/{computeCapacityTopologyId}/actions/changeCompartment
ChangeComputeCapacityTopologyCompartment
ChangeComputeCapacityTopologyCompartment 4 params body → 202400401404409412429500
GET
/computeCapacityTopologies/{computeCapacityTopologyId}/computeBareMetalHosts
ListComputeCapacityTopologyComputeBareMetalHosts
ListComputeCapacityTopologyComputeBareMetalHosts 11 params → 200400401404429500default
GET
/computeCapacityTopologies/{computeCapacityTopologyId}/computeHpcIslands
ListComputeCapacityTopologyComputeHpcIslands
ListComputeCapacityTopologyComputeHpcIslands 8 params → 200400401404429500default
GET
/computeCapacityTopologies/{computeCapacityTopologyId}/computeNetworkBlocks
ListComputeCapacityTopologyComputeNetworkBlocks
ListComputeCapacityTopologyComputeNetworkBlocks 9 params → 200400401404429500default
GET
/computeClusters
ListComputeCluster
ListComputeClusters 8 params → 200400401404412429500default
POST
/computeClusters
CreateComputeCluster
CreateComputeCluster 2 params body → 200400401409412429500default
DELETE
/computeClusters/{computeClusterId}
DeleteComputeCluster
DeleteComputeCluster 3 params → 204400401404409412429500
GET
/computeClusters/{computeClusterId}
GetComputeCluster
GetComputeCluster 2 params → 200400401404429500default
PUT
/computeClusters/{computeClusterId}
UpdateComputeCluster
UpdateComputeCluster 4 params body → 200400401409412429500default
POST
/computeClusters/{computeClusterId}/actions/changeCompartment
MoveComputeCluster
ChangeComputeClusterCompartment 4 params body → 204400401404409412429500
GET
/computeGlobalImageCapabilitySchemas
ListComputeGlobalImageCapabilitySchemas
ListComputeGlobalImageCapabilitySchemas 6 params → 200400401404429500default
GET
/computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}
GetComputeGlobalImageCapabilitySchema
GetComputeGlobalImageCapabilitySchema 1 param → 200401404429500default
GET
/computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}/versions
ListComputeGlobalImageCapabilitySchemaVersions
ListComputeGlobalImageCapabilitySchemaVersions 6 params → 200400401404429500default
GET
/computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}/versions/{computeGlobalImageCapabilitySchemaVersionName}
GetComputeGlobalImageCapabilitySchemaVersion
GetComputeGlobalImageCapabilitySchemaVersion 2 params → 200401404429500default
GET
/computeGpuMemoryClusters
ListComputeGpuMemoryClusters
ListComputeGpuMemoryClusters 11 params → 200400401404429500default
POST
/computeGpuMemoryClusters
CreateComputeGpuMemoryCluster
CreateComputeGpuMemoryCluster 2 params body → 201400401404409412429500
DELETE
/computeGpuMemoryClusters/{computeGpuMemoryClusterId}
DeleteComputeGpuMemoryCluster
DeleteComputeGpuMemoryCluster 3 params → 202401404409412429500default
GET
/computeGpuMemoryClusters/{computeGpuMemoryClusterId}
GetComputeGpuMemoryCluster
GetComputeGpuMemoryCluster 2 params → 200400401404409429500default
PUT
/computeGpuMemoryClusters/{computeGpuMemoryClusterId}
UpdateComputeGpuMemoryCluster
UpdateComputeGpuMemoryCluster 4 params body → 202400401404409412429500
POST
/computeGpuMemoryClusters/{computeGpuMemoryClusterId}/actions/changeCompartment
ChangeComputeGpuMemoryClusterCompartment
ChangeComputeGpuMemoryClusterCompartment 4 params body → 204400401404409412429500
GET
/computeGpuMemoryClusters/{computeGpuMemoryClusterId}/instances
ListComputeGpuMemoryClustersInstances
ListComputeGpuMemoryClusterInstances 6 params → 200400401404429500default
GET
/computeGpuMemoryFabrics
ListComputeGpuMemoryFabrics
ListComputeGpuMemoryFabrics 13 params → 200400401404429500default
GET
/computeGpuMemoryFabrics/{computeGpuMemoryFabricId}
GetComputeGpuMemoryFabric
GetComputeGpuMemoryFabric 2 params → 200400401404429500default
PUT
/computeGpuMemoryFabrics/{computeGpuMemoryFabricId}
UpdateComputeGpuMemoryFabric
UpdateComputeGpuMemoryFabric 4 params body → 200400401404409412429500
POST
/computeGpuMemoryFabrics/{computeGpuMemoryFabricId}/actions/changeCompartment
ChangeComputeGpuMemoryFabricCompartment
ChangeComputeGpuMemoryFabricCompartment 4 params body → 204400401404409412429500
GET
/computeHostGroups
ListComputeHostGroups
ListComputeHostGroups 4 params → 200400401404429500default
POST
/computeHostGroups
CreateComputeHostGroup
CreateComputeHostGroup 2 params body → 201400401404409429500default
DELETE
/computeHostGroups/{computeHostGroupId}
DeleteComputeHostGroup
DeleteComputeHostGroup 3 params → 202401404409412429500default
GET
/computeHostGroups/{computeHostGroupId}
GetComputeHostGroup
GetComputeHostGroup 2 params → 200400401404429500default
PUT
/computeHostGroups/{computeHostGroupId}
UpdateComputeHostGroup
UpdateComputeHostGroup 4 params body → 200400401404409412429500
POST
/computeHostGroups/{computeHostGroupId}/actions/changeCompartment
ChangeComputeHostGroupCompartment
ChangeComputeHostGroupCompartment 4 params body → 202400401404409412429500
GET
/computeHosts
ListComputeHosts
ListComputeHosts 13 params → 200400401404429500default
GET
/computeHosts/{computeHostId}
GetComputeHost
GetComputeHost 2 params → 200400401404429500default
PUT
/computeHosts/{computeHostId}
UpdateComputeHost
UpdateComputeHost 4 params body → 200400401404409412429500
POST
/computeHosts/{computeHostId}/actions/applyConfiguration
ApplyHostConfiguration
ApplyHostConfiguration 4 params → 202400401404409412429500
POST
/computeHosts/{computeHostId}/actions/attachToHostGroup
AttachComputeHostGroupHost
AttachComputeHostGroupHost 4 params body → 202400401404409412429500
POST
/computeHosts/{computeHostId}/actions/changeCompartment
ChangeComputeHostCompartment
ChangeComputeHostCompartment 4 params body → 202400401404409412429500
POST
/computeHosts/{computeHostId}/actions/checkConfiguration
CheckHostConfiguration
CheckHostConfiguration 4 params → 200400401404409412429500
POST
/computeHosts/{computeHostId}/actions/detachFromHostGroup
DetachComputeHostGroupHost
DetachComputeHostGroupHost 4 params body → 202401404409412429500default
GET
/computeImageCapabilitySchemas
ListComputeImageCapabilitySchemas
ListComputeImageCapabilitySchemas 7 params → 200400401404429500default
POST
/computeImageCapabilitySchemas
CreateComputeImageCapabilitySchema
CreateComputeImageCapabilitySchema 1 param body → 200400401404409429500default
DELETE
/computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}
DeleteComputeImageCapabilitySchema
DeleteComputeImageCapabilitySchema 2 params → 204401404412429500default
GET
/computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}
GetComputeImageCapabilitySchema
GetComputeImageCapabilitySchema 2 params → 200401404429500default
PUT
/computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}
UpdateComputeImageCapabilitySchema
UpdateComputeImageCapabilitySchema 2 params body → 200401404409412429500default
POST
/computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}/actions/changeCompartment
ChangeComputeImageCapabilitySchemaCompartment
ChangeComputeImageCapabilitySchemaCompartment 4 params body → 204400401404409412429500
GET
/dedicatedVmHostInstanceShapes
ListDedicatedVmHostInstanceShapes
ListDedicatedVmHostInstanceShapes 6 params → 200400401404500default
GET
/dedicatedVmHostShapes
ListDedicatedVmHostShapes
ListDedicatedVmHostShapes 6 params → 200400401404500default
GET
/dedicatedVmHosts
ListDedicatedVmHosts
ListDedicatedVmHosts 13 params → 200400401404500default
POST
/dedicatedVmHosts
CreateDedicatedVmHost
CreateDedicatedVmHost 2 params body → 200400401404409500default
DELETE
/dedicatedVmHosts/{dedicatedVmHostId}
DeleteDedicatedVmHost
DeleteDedicatedVmHost 2 params → 204401404409500default
GET
/dedicatedVmHosts/{dedicatedVmHostId}
GetDedicatedVmHost
GetDedicatedVmHost 2 params → 200401404500default
PUT
/dedicatedVmHosts/{dedicatedVmHostId}
UpdateDedicatedVmHost
UpdateDedicatedVmHost 4 params body → 200400401404409412500default
POST
/dedicatedVmHosts/{dedicatedVmHostId}/actions/changeCompartment
ChangeDedicatedVmHostCompartment
ChangeDedicatedVmHostCompartment 4 params body → 202400401404409500default
GET
/dedicatedVmHosts/{dedicatedVmHostId}/instances
ListDedicatedVmHostInstances
ListDedicatedVmHostInstances 9 params → 200400401404500default
GET
/firmwareBundles
ListFirmwareBundles
ListFirmwareBundles 7 params → 200400401404429500default
GET
/firmwareBundles/{firmwareBundleId}
GetFirmwareBundle
GetFirmwareBundle 2 params → 200400401404429500default
GET
/images
ListImages
ListImages 10 params → 200400401404500default
POST
/images
CreateImage
CreateImage 1 param body → 200400401404409500default
DELETE
/images/{imageId}
DeleteImage
DeleteImage 2 params → 204401404412500default
GET
/images/{imageId}
GetImage
GetImage 1 param → 200401404500default
PUT
/images/{imageId}
UpdateImage
UpdateImage 3 params body → 200400401404409412500default
POST
/images/{imageId}/actions/changeCompartment
ChangeImageCompartment
ChangeImageCompartment 4 params body → 204400401404409412500default
POST
/images/{imageId}/actions/export
ExportImage
ExportImage 3 params body → 200400401404409412500default
GET
/images/{imageId}/shapes
ListImageShapeCompatibilityEntries
ListImageShapeCompatibilityEntries 4 params → 200400401404500default
DELETE
/images/{imageId}/shapes/{shapeName}
RemoveImageShapeCompatibilityEntry
RemoveImageShapeCompatibilityEntry 2 params → 204400401404500default
GET
/images/{imageId}/shapes/{shapeName}
GetImageShapeCompatibilityEntry
GetImageShapeCompatibilityEntry 3 params → 200400401404500default
PUT
/images/{imageId}/shapes/{shapeName}
AddImageShapeCompatibilityEntry
AddImageShapeCompatibilityEntry 2 params body → 200400401404500default
GET
/instanceConsoleConnections
ListInstanceConsoleConnections
ListInstanceConsoleConnections 4 params → 200400401404500default
POST
/instanceConsoleConnections
CreateInstanceConsoleConnection
CreateInstanceConsoleConnection 1 param body → 200400401409500default
DELETE
/instanceConsoleConnections/{instanceConsoleConnectionId}
DeleteInstanceConsoleConnection
DeleteInstanceConsoleConnection 2 params → 204400401404409412500default
GET
/instanceConsoleConnections/{instanceConsoleConnectionId}
GetInstanceConsoleConnection
GetInstanceConsoleConnection 1 param → 400401404500200default
PUT
/instanceConsoleConnections/{instanceConsoleConnectionId}
UpdateInstanceConsoleConnection
UpdateInstanceConsoleConnection 3 params body → 200400401404412500default
GET
/instanceConsoleHistories/
ListConsoleHistories
ListConsoleHistories 8 params → 200400401404500default
POST
/instanceConsoleHistories/
CaptureConsoleHistory
CaptureConsoleHistory 1 param body → 200400401404409500default
DELETE
/instanceConsoleHistories/{instanceConsoleHistoryId}
DeleteConsoleHistory
DeleteConsoleHistory 2 params → 204401404409412500default
GET
/instanceConsoleHistories/{instanceConsoleHistoryId}
GetConsoleHistory
GetConsoleHistory 1 param → 200401404500default
PUT
/instanceConsoleHistories/{instanceConsoleHistoryId}
UpdateConsoleHistory
UpdateConsoleHistory 2 params body → 200400401404412500default
GET
/instanceConsoleHistories/{instanceConsoleHistoryId}/data
GetConsoleHistoryContent
GetConsoleHistoryContent 3 params → 200400401404500default
GET
/instanceMaintenanceEvents
ListInstanceMaintenanceEvents
ListInstanceMaintenanceEvents 12 params → 200400401404429500default
GET
/instanceMaintenanceEvents/{instanceMaintenanceEventId}
GetInstanceMaintenanceEvent
GetInstanceMaintenanceEvent 2 params → 200400401404429500default
PUT
/instanceMaintenanceEvents/{instanceMaintenanceEventId}
UpdateInstanceMaintenanceEvent
UpdateInstanceMaintenanceEvent 4 params body → 202400401404409412429500
GET
/instances/
ListInstances
ListInstances 10 params → 200400401404500default
POST
/instances/
LaunchInstance
LaunchInstance 1 param body → 200400401404409500default
DELETE
/instances/{instanceId}
TerminateInstance
TerminateInstance 5 params → 204401404412500default
GET
/instances/{instanceId}
GetInstance
GetInstance 1 param → 200401404500default
POST
/instances/{instanceId}
InstanceAction
InstanceAction 4 params body → 200400401404409412500default
PUT
/instances/{instanceId}
UpdateInstance
UpdateInstance 3 params body → 200401404409412500default
POST
/instances/{instanceId}/actions/acceptShieldedIntegrityPolicy
AcceptShieldedIntegrityPolicy
AcceptShieldedIntegrityPolicy 4 params → 202400401404412500default
POST
/instances/{instanceId}/actions/changeCompartment
ChangeInstanceCompartment
ChangeInstanceCompartment 4 params body → 202400401404409500default
GET
/instances/{instanceId}/defaultCredentials
GetInstanceDefaultCredentials
GetInstanceDefaultCredentials 1 param → 200401404500default
GET
/instances/{instanceId}/devices
ListInstanceDevices
ListInstanceDevices 8 params → 200400401404500default
GET
/instances/{instanceId}/initialCredentialsdeprecated
GetWindowsInstanceInitialCredentials
GetWindowsInstanceInitialCredentials 1 param → 200404500default
GET
/instances/{instanceId}/maintenanceReboot
GetInstanceMaintenanceReboot
GetInstanceMaintenanceReboot 2 params → 200401404500default
GET
/instances/{instanceId}/measuredBootReport
GetMeasuredBootReport
GetMeasuredBootReport 2 params → 200400401404500default
GET
/shapes
ListShapes
ListShapes 6 params → 200400401404500default
GET
/vnicAttachments/
ListVnicAttachments
ListVnicAttachments 6 params → 200400401404500default
POST
/vnicAttachments/
AttachVnic
AttachVnic 1 param body → 200400401404409500default
DELETE
/vnicAttachments/{vnicAttachmentId}
DetachVnic
DetachVnic 2 params → 204400401404412500default
GET
/vnicAttachments/{vnicAttachmentId}
GetVnicAttachment
GetVnicAttachment 1 param → 200401404500default
GET
/volumeAttachments/
ListVolumeAttachments
ListVolumeAttachments 6 params → 200400401404500default
POST
/volumeAttachments/
AttachVolume
AttachVolume 1 param body → 200400401404409500default
DELETE
/volumeAttachments/{volumeAttachmentId}
DetachVolume
DetachVolume 2 params → 204401404409500default
GET
/volumeAttachments/{volumeAttachmentId}
GetVolumeAttachment
GetVolumeAttachment 1 param → 200401404500default
PUT
/volumeAttachments/{volumeAttachmentId}
UpdateVolumeAttachment
UpdateVolumeAttachment 3 params body → 200400401404409412429500

Schemas 190

The contract defines 190 schemas that model the data the API accepts and returns. The most detailed are Instance (34 properties), LaunchInstanceDetails (34 properties), Shape (31 properties), ComputeHost (28 properties). Each schema is shown below with its type and property counts.

LaunchInstanceLicensingConfig
object
The license config requested for the instance.
2 properties 1 required
ShapeMemoryOptions
object
For a flexible shape, the amount of memory available for instances that use this shape. If this field is null, then this shape has a fixed amount of memory equ…
5 properties
ChangeComputeGpuMemoryClusterCompartmentDetails
object
Specifies the compartment to move the compute GPU Memory Cluster to.
1 property 1 required
CapacityReportShapeAvailability
object
Information about the available capacity for a shape.
5 properties
ComputeHostGroupSummary
object
Summary information for a compute host group.
11 properties 7 required
PlatformConfig
object
The platform configuration for the instance.
5 properties 1 required
CreateAppCatalogSubscriptionDetails
object
details for creating a subscription for a listing resource version.
7 properties 6 required
LaunchInstanceAvailabilityConfigDetails
object
Options for VM migration during infrastructure maintenance events and for defining the availability of a VM instance after a maintenance event that impacts the…
2 properties
PercentageOfCoresEnabledOptions
object
Configuration options for the percentage of cores enabled.
3 properties
ComputeHostConfigurationData
object
Compute Host Configuration Data
2 properties
Device
object
Device Path corresponding to the block devices attached to instances having a name and isAvailable flag.
2 properties 2 required
ExportImageDetails
object
The destination details for the image export. Set destinationType to objectStorageTuple and use [ExportImageViaObjectStorageTupleDetails](/en/iaas/latest/reque…
2 properties 1 required
ShapeOcpuOptions
object
For a flexible shape, the number of OCPUs available for instances that use this shape. If this field is null, then this shape has a fixed number of OCPUs equal…
2 properties
ShapeInputOutputMemoryManagementUnitEnabledPlatformOptions
object
Configuration options for the input-output memory management unit (IOMMU).
2 properties
PlacementConstraintDetails
object
The details for providing placement constraints.
1 property 1 required
LaunchCreateVolumeDetails
object
Define a volume that will be created and attached or attached to an instance on creation.
1 property 1 required
AppCatalogListingResourceVersionSummary
object
Listing Resource Version summary
4 properties
CreateDedicatedVmHostDetails
object
The details for creating a new dedicated virtual machine host.
11 properties 3 required
UpdateComputeImageCapabilitySchemaDetails
object
Create Image Capability Schema for an image.
4 properties
ComputeGpuMemoryClusterScaleConfig
object
Configuration settings for GPU Memory Cluster scaling.
3 properties
ChangeDedicatedVmHostCompartmentDetails
object
Specifies the compartment to move the dedicated virtual machine host to.
1 property 1 required
ComputeCapacityTopologyCollection
object
A list of compute capacity topologies.
1 property 1 required
CapacityBin
object
Total and remaining CPU and memory capacity for each capacity bucket.
6 properties 6 required
ComputeGpuMemoryClusterInstanceCollection
object
A list of compute GPU Memory Cluster instances.
1 property 1 required
AppCatalogListingResourceVersionAgreements
object
Agreements for a listing resource version.
6 properties
CreateImageDetails
object
Either instanceId or imageSourceDetails must be provided in addition to other required parameters.
8 properties 1 required
InstanceAvailabilityConfig
object
Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.
2 properties
ShapeMaxVnicAttachmentOptions
object
For a flexible shape, the number of VNIC attachments that are available for instances that use this shape. If this field is null, then this shape has a fixed m…
3 properties
CreateComputeGpuMemoryClusterDetails
object
The customer facing object includes GPU Memory Cluster details.
11 properties 4 required
PlatformVersions
object
A platform's pinned firmware versions.
2 properties
DedicatedVmHostShapeSummary
object
The shape used to launch the dedicated virtual machine (VM) host.
3 properties 1 required
UpdateComputeGpuMemoryFabricDetails
object
Updates compute GPU memory fabric details.
4 properties
ComponentVersion
object
Represents a specific component type and its associated firmware versions.
2 properties 2 required
AttachVnicDetails
object
4 properties 2 required
AppCatalogSubscriptionSummary
object
a subscription summary for a listing resource version.
8 properties
UpdateInstanceSourceDetails
object
The details for updating the instance source.
2 properties 1 required
FirmwareBundle
object
A collection of pinned component firmware versions organized by platform.
9 properties 8 required
Image
object
A boot disk image for launching an instance. For more information, see [Overview of the Compute Service](/iaas/Content/Compute/Concepts/computeoverview.htm). T…
16 properties 7 required
ComputeGpuMemoryFabric
object
The customer facing object includes GPU memory fabric details.
24 properties 10 required
MeasuredBootReport
object
The measured boot report for a shielded instance.
2 properties 1 required
FirmwareBundleSummary
object
Summary of a firmware bundle, returned in list operations.
9 properties 7 required
InstanceOptions
object
Optional mutable instance options
1 property
DedicatedVmHostSummary
object
A dedicated virtual machine (VM) host lets you host multiple instances on a dedicated server that is not shared with other tenancies.
14 properties 9 required
SupportedCapabilities
object
Specifies the capabilities that the Dedicated Virtual Machine Host (DVMH) Shape or Virtual Machine Instance Shape could support.
2 properties 1 required
ChangeImageCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
UpdateComputeHostGroupDetails
object
Update details information for a compute host group.
5 properties
ComputeCluster
object
The data for creating a [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm). After the compute cluster is created, you can use the compute clus…
10 properties 5 required
ComputeClusterCollection
object
A list of compute clusters that match filter criteria, if any. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory…
1 property 1 required
ComputeClusterSummary
object
Summary information for a compute cluster. A [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory access (RDMA) networ…
8 properties 5 required
ShapeNumaNodesPerSocketPlatformOptions
object
Configuration options for NUMA nodes per socket.
2 properties
InstanceAgentPluginConfigDetails
object
The configuration of plugins associated with this instance.
2 properties 2 required
LaunchInstancePlatformConfig
object
The platform configuration requested for the instance. If you provide the parameter, the instance is created with the platform configuration that you specify.…
5 properties 1 required
VnicAttachment
object
Represents an attachment between a VNIC and an instance. For more information, see [Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managi…
12 properties 6 required
UpdateInstanceConsoleConnectionDetails
object
Specifies the properties for updating tags for an instance console connection.
2 properties
HostGroupConfiguration
object
Host group configuration
4 properties
ChangeComputeCapacityReservationCompartmentDetails
object
Specifies the compartment to move the compute capacity reservation to.
1 property 1 required
PreemptibleInstanceConfigDetails
object
Configuration options for preemptible instances.
1 property 1 required
CreateComputeHostGroupDetails
object
Detail information for a compute host group.
7 properties 4 required
InstancePowerActionDetails
object
A base object for all types of instance power action requests.
1 property 1 required
AppCatalogListing
object
Listing details.
8 properties
CreateComputeImageCapabilitySchemaDetails
object
Create Image Capability Schema for an image.
7 properties 4 required
UpdateLaunchOptions
object
Options for tuning the compatibility and performance of VM shapes.
3 properties
UpdateComputeHostDetails
object
The details for updating the compute host.
3 properties
ComputeCapacityTopologySummary
object
Summary information for a compute capacity topology.
9 properties 6 required
ComputeBareMetalHostCollection
object
A list of compute bare metal hosts.
1 property 1 required
CreateComputeCapacityTopologyDetails
object
The details for creating a new compute capacity topology.
6 properties 3 required
CapacityBinPreview
object
Total CPU and memory capacity for each capacity bucket.
4 properties 4 required
ImageSourceDetails
object
4 properties 1 required
ImageShapeCompatibilityEntry
object
An image and shape that are compatible.
4 properties 2 required
ShapeSecureBootOptions
object
Configuration options for Secure Boot.
2 properties
CapacityReservationInstanceSummary
object
Condensed instance data when listing instances in a compute capacity reservation.
7 properties 4 required
UpdateComputeGpuMemoryClusterDetails
object
Updates compute GPU Memory Cluster details.
7 properties
InstanceReservationConfig
object
Data that defines the capacity configuration.
7 properties 3 required
ComputeNetworkBlockCollection
object
A list of compute network blocks.
1 property 1 required
ShapeMemoryEncryptionOptions
object
Configuration options for memory encryption.
2 properties
UpdateInstanceDetails
object
19 properties
LaunchOptions
object
Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
6 properties
UpdateDedicatedVmHostDetails
object
Details for updating the dedicated virtual machine host details.
3 properties
BootVolumeAttachment
object
Represents an attachment between a boot volume and an instance. Warning: Oracle recommends that you avoid using any confidential information when you supply st…
11 properties 7 required
ComputeImageCapabilitySchemaSummary
object
Summary information for a compute image capability schema
9 properties 5 required
ComputeCapacityReport
object
A report of the host capacity within an availability domain that is available for you to create compute instances. Host capacity is the physical infrastructure…
4 properties 4 required
Ipv6AddressIpv6SubnetCidrPairDetails
object
Details to assign an IPv6 subnet prefix and IPv6 address on VNIC creation.
3 properties
UpdateVolumeAttachmentDetails
object
details for updating a volume attachment.
1 property
DetachComputeHostGroupHostDetails
object
Specifies the host group id
1 property 1 required
UpdateComputeCapacityReservationDetails
object
Details for updating the compute capacity reservation.
5 properties
ComputeGlobalImageCapabilitySchemaVersion
object
Compute Global Image Capability Schema Version is a set of all possible capabilities for a collection of images.
5 properties 5 required
ComputeGpuMemoryClusterInstanceSummary
object
The customer facing GPU Memory Cluster instance object details.
10 properties
LaunchInstanceDetails
object
Instance launch details. Use the sourceDetails parameter to specify whether a boot volume or an image should be used to launch a new instance.
34 properties 2 required
ChangeComputeHostCompartmentDetails
object
Specifies the compartment to move the compute host to.
1 property 1 required
ComputeImageCapabilitySchema
object
Compute Image Capability Schema is a set of capabilities that filter the compute global capability schema version for an image.
11 properties 7 required
AppCatalogSubscription
object
a subscription for a listing resource version.
8 properties
ChangeComputeCapacityTopologyCompartmentDetails
object
Specifies the compartment to move the compute capacity topology to.
1 property 1 required
ComputeHostSummary
object
Summary information for a compute host.
22 properties 10 required
InstanceMaintenanceEvent
object
It is the event in which the maintenance action will be be performed on the customer instance on the scheduled date and time.
25 properties 12 required
ComputeCapacityReservation
object
A template that defines the settings to use when creating compute capacity reservations.
13 properties 5 required
CreateComputeCapacityReservationDetails
object
The details for creating a new compute capacity reservation.
7 properties 2 required
ComputeCapacityReservationSummary
object
Summary information for a compute capacity reservation.
11 properties 3 required
DedicatedVmHostInstanceShapeSummary
object
The shape used to launch instances associated with the dedicated VM host.
3 properties 1 required
ComputeGpuMemoryCluster
object
The customer facing object includes GPU Memory Cluster details.
15 properties 8 required
AddImageShapeCompatibilityEntryDetails
object
Image shape compatibility details.
2 properties
UpdateComputeGpuMemoryClusterScaleConfig
object
Configuration settings for GPU Memory Cluster scaling.
3 properties
ShapeTrustedPlatformModuleOptions
object
Configuration options for the Trusted Platform Module (TPM).
2 properties
RecycleDetails
object
Shows details about the last recycle performed on this host.
2 properties
InstanceShapeConfig
object
The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.
13 properties
ComputeHostConfigurationCheckDetails
object
Compute Host Group Configuration Details Check
4 properties
UpdateInstanceMaintenanceEventDetails
object
Specifies the properties for updating maintenance due date.
6 properties
ComputeGpuMemoryClusterSummary
object
Summary model for listing Compute GPU Memory Clusters.
11 properties 5 required
ChangeComputeGpuMemoryFabricCompartmentDetails
object
Specifies the compartment to move the compute GPU memory fabric to.
1 property 1 required
UpdateInstanceShapeConfigDetails
object
The shape configuration requested for the instance. If provided, the instance will be updated with the resources specified. In the case where some properties a…
6 properties
LicensingConfig
object
Configuration of the Operating System license.
3 properties
ComputeCapacityTopology
object
A compute capacity topology that allows you to query your bare metal hosts and their RDMA network topology.
10 properties 7 required
UpdateComputeClusterDetails
object
The data to update a [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm). Use COMPUTECLUSTER type when using placementConstraintDetails. placem…
4 properties
PreemptionAction
object
The action to run when the preemptible instance is interrupted for eviction.
1 property 1 required
ComputeGlobalImageCapabilitySchema
object
Compute Global Image Capability Schema is a container for a set of compute global image capability schema versions
7 properties 3 required
ComputeGlobalImageCapabilitySchemaVersionSummary
object
Summary information for a compute global image capability schema
4 properties 3 required
MeasuredBootEntry
object
One Trusted Platform Module (TPM) Platform Configuration Register (PCR) entry. The entry might be measured during boot, or specified in a policy.
3 properties
ImageMemoryConstraints
object
For a flexible image and shape, the amount of memory supported for instances that use this image.
2 properties
UpdateConsoleHistoryDetails
object
3 properties
ComputeCapacityReservationInstanceShapeSummary
object
An available shape used to launch instances in a compute capacity reservation.
2 properties 2 required
CreateVnicDetails
object
Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more informati…
16 properties
MemoryFabricPreferencesDescriptor
object
The preference object specified by customer. Contains customerDesiredFirmwareBundleId, fabricRecycleLevel.
2 properties
ComputeHpcIslandSummary
object
Summary information for a compute HPC island.
6 properties 6 required
InstanceAgentConfig
object
Configuration options for the Oracle Cloud Agent software running on the instance.
4 properties
CreateCapacityReportShapeAvailabilityDetails
object
Information about the shapes in a capacity report.
3 properties 1 required
CreateCapacitySourceDetails
object
A capacity source of bare metal hosts.
1 property 1 required
DedicatedVmHost
object
A dedicated virtual machine host lets you host multiple VM instances on a dedicated server that is not shared with other tenancies.
20 properties 9 required
ClusterConfigDetails
object
The HPC cluster configuration requested when launching instances in a compute capacity reservation. If the parameter is provided, the reservation is created wi…
2 properties 1 required
ComputeGlobalImageCapabilitySchemaSummary
object
Summary information for a compute global image capability schema
7 properties 3 required
ImageShapeCompatibilitySummary
object
Summary information for a compatible image and shape.
4 properties 2 required
FirmwareBundlesCollection
object
Results of a firmwareBundles search. Contains FirmwareBundleSummary items.
1 property 1 required
ComputeGpuMemoryClusterCollection
object
A list of compute GPU Memory Clusters.
1 property 1 required
CapacityConfig
object
Specifies the capacity configs that the Dedicated Virtual Machine Host (DVMH) Shape could support.
4 properties
UpdateInstanceAvailabilityConfigDetails
object
Options for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware, including whether to live migrate suppor…
2 properties
ShapeSymmetricMultiThreadingEnabledPlatformOptions
object
Configuration options for symmetric multithreading (also called simultaneous multithreading or SMT).
2 properties
MeasuredBootReportMeasurements
object
A list of Trusted Platform Module (TPM) Platform Configuration Register (PCR) entries.
2 properties
ShapeNetworkingBandwidthOptions
object
For a flexible shape, the amount of networking bandwidth available for instances that use this shape. If this field is null, then this shape has a fixed amount…
3 properties
ImageOcpuConstraints
object
OCPU options for an image and shape.
2 properties
ShapePlatformConfigOptions
object
The list of supported platform configuration options for this shape.
11 properties
ChangeInstanceCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
UpdateImageDetails
object
5 properties
ChangeComputeHostGroupCompartmentDetails
object
Specifies the compartment to move the compute host group to.
1 property 1 required
InstanceMaintenanceReboot
object
The maximum possible date and time that a maintenance reboot can be extended.
1 property 1 required
InstanceConsoleConnection
object
The InstanceConsoleConnection API provides you with console access to Compute instances, enabling you to troubleshoot malfunctioning instances remotely. For mo…
10 properties
ComputeHostGroup
object
Detail information for a compute host group.
12 properties 5 required
ImageCapabilitySchemaDescriptor
object
Image Capability Schema Descriptor is a type of capability for an image.
2 properties 2 required
LaunchInstanceShapeConfigDetails
object
The shape configuration requested for the instance. If the parameter is provided, the instance is created with the resources that you specify. If some properti…
6 properties
UpdateComputeCapacityTopologyDetails
object
The details for updating the compute capacity topology.
4 properties
DedicatedVmHostInstanceSummary
object
Condensed instance data when listing instances on a dedicated VM host.
7 properties 5 required
InstanceReservationShapeConfigDetails
object
The shape configuration requested when launching instances in a compute capacity reservation. If the parameter is provided, the reservation is created with the…
2 properties
InstanceSourceDetails
object
1 property 1 required
ShapeAlternativeObject
object
The shape that Oracle recommends you to use an alternative to the current shape.
1 property 1 required
CaptureConsoleHistoryDetails
object
4 properties 1 required
ComputeGpuMemoryFabricCollection
object
A list of compute GPU memory fabrics.
1 property 1 required
ComputeGpuMemoryFabricSummary
object
Summary information for a compute GPU memory fabric.
21 properties 9 required
ComputeHpcIslandCollection
object
A list of compute HPC islands.
1 property 1 required
CapacitySource
object
A capacity source of bare metal hosts.
1 property 1 required
UpdateInstanceAgentConfigDetails
object
Configuration options for the Oracle Cloud Agent software running on the instance.
4 properties
InstanceMaintenanceEventSummary
object
It is the event in which the maintenance action will be be performed on the customer instance on the scheduled date and time.
22 properties 12 required
CreateComputeGpuMemoryClusterScaleConfig
object
Configuration settings for GPU Memory Cluster scaling.
3 properties 1 required
ShapeVirtualInstructionsEnabledPlatformOptions
object
Configuration options for the virtualization instructions.
2 properties
LaunchInstanceAgentConfigDetails
object
Configuration options for the Oracle Cloud Agent software running on the instance.
4 properties
CreateInstanceConsoleConnectionDetails
object
The details for creating a instance console connection. The instance console connection is created in the same compartment as the instance.
4 properties 2 required
ChangeComputeImageCapabilitySchemaCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
InstanceAgentFeatures
object
Oracle Cloud Agent features supported on the image.
2 properties
InstanceCredentials
object
The credentials for a particular instance.
2 properties 2 required
UpdateCapacitySourceDetails
object
A capacity source of bare metal hosts.
1 property 1 required
AttachVolumeDetails
object
7 properties 3 required
CreateComputeClusterDetails
object
The data for creating a [compute cluster](/iaas/Content/Compute/Tasks/compute-clusters.htm). After the compute cluster is created, you can use the compute clus…
6 properties 2 required
AttachBootVolumeDetails
object
4 properties 2 required
AppCatalogListingResourceVersion
object
Listing Resource Version
8 properties
ComputeNetworkBlockSummary
object
Summary information for a compute network block.
7 properties 7 required
LaunchAttachVolumeDetails
object
The details of the volume to attach.
7 properties 1 required
ShapeAccessControlServiceEnabledPlatformOptions
object
Configuration options for the Access Control Service.
2 properties
InstanceReservationConfigDetails
object
A template that contains the settings to use when defining the instance capacity configuration.
6 properties 2 required
VolumeAttachment
object
A base object for all types of attachments between a storage volume and an instance. For specific details about iSCSI attachments, see [IScsiVolumeAttachment R…
16 properties 8 required
ComputeBareMetalHostSummary
object
Summary information for a compute bare metal host.
11 properties 6 required
AppCatalogListingSummary
object
A summary of a listing.
4 properties
ComputeHostCollection
object
A list of compute hosts.
1 property 1 required
Error
object
5 properties 2 required
CapacityReportInstanceShapeConfig
object
The shape configuration for a shape in a capacity report.
4 properties
Instance
object
A compute host. The image used to launch the instance determines its operating system and other software. The shape specified during the launch process determi…
34 properties 7 required
ConsoleHistory
object
An instance's serial console data. It includes configuration messages that occur when the instance boots, such as kernel and BIOS messages, and is useful for c…
9 properties 6 required
AttachComputeHostGroupHostDetails
object
Specifies the host group id
1 property 1 required
CreateComputeCapacityReportDetails
object
The data to create a report of available Compute capacity.
3 properties 3 required
FirmwareBundleTransitions
object
A map of firmware bundle upgrades/downgrades validated by OCI.
2 properties
ComputeHost
object
The customer facing object includes host details.
28 properties 9 required
ShapeMeasuredBootOptions
object
Configuration options for the Measured Boot feature.
2 properties
ComputeHostGroupCollection
object
A list of compute host groups.
1 property 1 required
Shape
object
A compute instance shape that can be used in [LaunchInstance](/en/iaas/latest/Instance/LaunchInstance). For more information, see [Overview of the Compute Serv…
31 properties 1 required
ChangeComputeClusterCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-platforms-compute-api-openapi.yml Raw ↑

Other APIs Oracle Platforms publishes across the network.

Oracle Fusion Cloud ERP API
Oracle APEX REST APIs
Oracle Platforms Analytics API
Oracle Platforms Blockstorage API
Oracle Platforms Compute Management API
Oracle Platforms Database API
Oracle Platforms Data Science API
Oracle Platforms Integration Instance API
Oracle Platforms Oce Instance API
Oracle Platforms Virtual Network API
Where this information came from

This is an independent, third-party profile of Oracle Platforms Compute API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.