openapi: 3.1.0 info: title: Oracle OCI Compute API description: >- The Oracle Cloud Infrastructure Compute API provides REST endpoints for managing compute instances, shapes, and images. You can launch and manage virtual machine (VM) and bare metal instances, query available compute shapes, list and manage custom images, and configure instance console connections. All API requests require OCI request signing for authentication. version: '20160918' contact: name: Oracle Cloud Infrastructure Support url: https://support.oracle.com license: name: Oracle Technology Network License Agreement url: https://www.oracle.com/downloads/licenses/oracle-oci-api-license.html termsOfService: https://www.oracle.com/legal/terms.html externalDocs: description: OCI Compute Service Documentation url: https://docs.oracle.com/en-us/iaas/Content/Compute/Concepts/computeoverview.htm servers: - url: https://iaas.{region}.oraclecloud.com/20160918 description: OCI Compute API regional endpoint variables: region: description: >- The OCI region identifier (e.g., us-ashburn-1, us-phoenix-1, eu-frankfurt-1, ap-tokyo-1) default: us-ashburn-1 enum: - us-ashburn-1 - us-phoenix-1 - us-chicago-1 - us-sanjose-1 - ca-toronto-1 - ca-montreal-1 - eu-frankfurt-1 - eu-amsterdam-1 - eu-zurich-1 - eu-madrid-1 - uk-london-1 - ap-tokyo-1 - ap-osaka-1 - ap-seoul-1 - ap-mumbai-1 - ap-sydney-1 - ap-melbourne-1 - sa-saopaulo-1 - me-jeddah-1 - af-johannesburg-1 tags: - name: Console Connections description: Manage instance console connections for troubleshooting - name: Images description: Manage compute images used to launch instances - name: Instances description: Manage compute instances including launch, terminate, and lifecycle operations - name: Shapes description: List available compute shapes that define CPU, memory, and networking resources - name: VNIC Attachments description: Manage virtual network interface card attachments for instances - name: Volume Attachments description: Manage block volume attachments for instances security: - ociRequestSigning: [] paths: /instances: get: operationId: listInstances summary: Oracle List Instances description: >- Lists the instances in the specified compartment and the specified availability domain. You can filter the results by specifying an instance display name or lifecycle state. tags: - Instances parameters: - $ref: '#/components/parameters/compartmentId' - name: availabilityDomain in: query description: >- The name of the availability domain (e.g., Uocm:PHX-AD-1). If not specified, returns instances across all availability domains in the compartment. schema: type: string example: example_value - name: displayName in: query description: A filter to return only resources that match the given display name exactly schema: type: string example: example_value - name: lifecycleState in: query description: A filter to return only instances that match the given lifecycle state schema: $ref: '#/components/schemas/InstanceLifecycleState' example: example_value - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/sortBy' - $ref: '#/components/parameters/sortOrder' responses: '200': description: The list of instances headers: opc-next-page: description: >- For pagination. When this header appears in the response, additional pages of results remain. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request schema: type: string content: application/json: schema: type: array items: $ref: '#/components/schemas/Instance' examples: Listinstances200Example: summary: Default listInstances 200 response x-microcks-default: true value: - id: abc123 compartmentId: '500123' availabilityDomain: example_value faultDomain: example_value displayName: example_value shape: example_value shapeConfig: ocpus: 42.5 memoryInGBs: 42.5 baselineOcpuUtilization: BASELINE_1_8 processorDescription: example_value networkingBandwidthInGbps: 42.5 maxVnicAttachments: 10 gpus: 10 gpuDescription: example_value localDisks: 10 localDisksTotalSizeInGBs: 42.5 vcpus: 10 region: example_value imageId: '500123' sourceDetails: sourceType: image imageId: '500123' bootVolumeId: '500123' bootVolumeSizeInGBs: 10 bootVolumeVpusPerGB: 10 lifecycleState: MOVING timeCreated: '2026-01-15T10:30:00Z' metadata: example_value extendedMetadata: example_value launchMode: NATIVE launchOptions: bootVolumeType: ISCSI firmware: BIOS networkType: E1000 remoteDataVolumeType: ISCSI isPvEncryptionInTransitEnabled: true isConsistentVolumeNamingEnabled: true agentConfig: isMonitoringDisabled: true isManagementDisabled: true areAllPluginsDisabled: true pluginsConfig: {} availabilityConfig: isLiveMigrationPreferred: true recoveryAction: RESTORE_INSTANCE platformConfig: type: AMD_MILAN_BM isSecureBootEnabled: true isTrustedPlatformModuleEnabled: true isMeasuredBootEnabled: true isMemoryEncryptionEnabled: true timeMaintenanceRebootDue: '2026-01-15T10:30:00Z' capacityReservationId: '500123' dedicatedVmHostId: '500123' isCrossNumaNode: true definedTags: {} freeformTags: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: launchInstance summary: Oracle Launch an Instance description: >- Creates a new instance in the specified compartment and the specified availability domain. For general information about instances, see Overview of the Compute Service. The instance is launched with the specified image, shape, and networking configuration. tags: - Instances parameters: - $ref: '#/components/parameters/opcRetryToken' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LaunchInstanceDetails' examples: LaunchinstanceRequestExample: summary: Default launchInstance request x-microcks-default: true value: compartmentId: '500123' availabilityDomain: example_value displayName: example_value shape: example_value shapeConfig: ocpus: 42.5 memoryInGBs: 42.5 baselineOcpuUtilization: BASELINE_1_8 nvmes: 10 sourceDetails: sourceType: image imageId: '500123' bootVolumeId: '500123' bootVolumeSizeInGBs: 10 bootVolumeVpusPerGB: 10 createVnicDetails: subnetId: '500123' displayName: example_value assignPublicIp: true assignPrivateDnsRecord: true privateIp: example_value hostnameLabel: example_value nsgIds: - {} skipSourceDestCheck: true metadata: example_value extendedMetadata: example_value faultDomain: example_value launchOptions: bootVolumeType: ISCSI firmware: BIOS networkType: E1000 remoteDataVolumeType: ISCSI isPvEncryptionInTransitEnabled: true isConsistentVolumeNamingEnabled: true agentConfig: isMonitoringDisabled: true isManagementDisabled: true areAllPluginsDisabled: true pluginsConfig: - {} availabilityConfig: isLiveMigrationPreferred: true recoveryAction: RESTORE_INSTANCE platformConfig: type: AMD_MILAN_BM isSecureBootEnabled: true isTrustedPlatformModuleEnabled: true isMeasuredBootEnabled: true isMemoryEncryptionEnabled: true isPvEncryptionInTransitEnabled: true capacityReservationId: '500123' dedicatedVmHostId: '500123' definedTags: {} freeformTags: {} responses: '200': description: The instance was launched successfully headers: etag: description: Entity tag for the instance resource schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request schema: type: string content: application/json: schema: $ref: '#/components/schemas/Instance' examples: Launchinstance200Example: summary: Default launchInstance 200 response x-microcks-default: true value: id: abc123 compartmentId: '500123' availabilityDomain: example_value faultDomain: example_value displayName: example_value shape: example_value shapeConfig: ocpus: 42.5 memoryInGBs: 42.5 baselineOcpuUtilization: BASELINE_1_8 processorDescription: example_value networkingBandwidthInGbps: 42.5 maxVnicAttachments: 10 gpus: 10 gpuDescription: example_value localDisks: 10 localDisksTotalSizeInGBs: 42.5 vcpus: 10 region: example_value imageId: '500123' sourceDetails: sourceType: image imageId: '500123' bootVolumeId: '500123' bootVolumeSizeInGBs: 10 bootVolumeVpusPerGB: 10 lifecycleState: MOVING timeCreated: '2026-01-15T10:30:00Z' metadata: example_value extendedMetadata: example_value launchMode: NATIVE launchOptions: bootVolumeType: ISCSI firmware: BIOS networkType: E1000 remoteDataVolumeType: ISCSI isPvEncryptionInTransitEnabled: true isConsistentVolumeNamingEnabled: true agentConfig: isMonitoringDisabled: true isManagementDisabled: true areAllPluginsDisabled: true pluginsConfig: - {} availabilityConfig: isLiveMigrationPreferred: true recoveryAction: RESTORE_INSTANCE platformConfig: type: AMD_MILAN_BM isSecureBootEnabled: true isTrustedPlatformModuleEnabled: true isMeasuredBootEnabled: true isMemoryEncryptionEnabled: true timeMaintenanceRebootDue: '2026-01-15T10:30:00Z' capacityReservationId: '500123' dedicatedVmHostId: '500123' isCrossNumaNode: true definedTags: {} freeformTags: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instances/{instanceId}: get: operationId: getInstance summary: Oracle Get an Instance description: >- Gets information about the specified instance, including its current lifecycle state, shape, image, networking details, and metadata. tags: - Instances parameters: - $ref: '#/components/parameters/instanceId' responses: '200': description: The instance details headers: etag: description: Entity tag for the instance resource schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request schema: type: string content: application/json: schema: $ref: '#/components/schemas/Instance' examples: Getinstance200Example: summary: Default getInstance 200 response x-microcks-default: true value: id: abc123 compartmentId: '500123' availabilityDomain: example_value faultDomain: example_value displayName: example_value shape: example_value shapeConfig: ocpus: 42.5 memoryInGBs: 42.5 baselineOcpuUtilization: BASELINE_1_8 processorDescription: example_value networkingBandwidthInGbps: 42.5 maxVnicAttachments: 10 gpus: 10 gpuDescription: example_value localDisks: 10 localDisksTotalSizeInGBs: 42.5 vcpus: 10 region: example_value imageId: '500123' sourceDetails: sourceType: image imageId: '500123' bootVolumeId: '500123' bootVolumeSizeInGBs: 10 bootVolumeVpusPerGB: 10 lifecycleState: MOVING timeCreated: '2026-01-15T10:30:00Z' metadata: example_value extendedMetadata: example_value launchMode: NATIVE launchOptions: bootVolumeType: ISCSI firmware: BIOS networkType: E1000 remoteDataVolumeType: ISCSI isPvEncryptionInTransitEnabled: true isConsistentVolumeNamingEnabled: true agentConfig: isMonitoringDisabled: true isManagementDisabled: true areAllPluginsDisabled: true pluginsConfig: - {} availabilityConfig: isLiveMigrationPreferred: true recoveryAction: RESTORE_INSTANCE platformConfig: type: AMD_MILAN_BM isSecureBootEnabled: true isTrustedPlatformModuleEnabled: true isMeasuredBootEnabled: true isMemoryEncryptionEnabled: true timeMaintenanceRebootDue: '2026-01-15T10:30:00Z' capacityReservationId: '500123' dedicatedVmHostId: '500123' isCrossNumaNode: true definedTags: {} freeformTags: {} '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: updateInstance summary: Oracle Update an Instance description: >- Updates certain fields on the specified instance. Fields that are not provided in the request will not be updated. You can update the display name, defined tags, freeform tags, shape, and metadata. tags: - Instances parameters: - $ref: '#/components/parameters/instanceId' - $ref: '#/components/parameters/ifMatch' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateInstanceDetails' examples: UpdateinstanceRequestExample: summary: Default updateInstance request x-microcks-default: true value: displayName: example_value shape: example_value shapeConfig: ocpus: 42.5 memoryInGBs: 42.5 baselineOcpuUtilization: BASELINE_1_8 nvmes: 10 metadata: example_value extendedMetadata: example_value agentConfig: isMonitoringDisabled: true isManagementDisabled: true areAllPluginsDisabled: true pluginsConfig: - {} availabilityConfig: isLiveMigrationPreferred: true recoveryAction: RESTORE_INSTANCE faultDomain: example_value definedTags: {} freeformTags: {} responses: '200': description: The instance was updated successfully headers: etag: description: Entity tag for the updated instance resource schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request schema: type: string content: application/json: schema: $ref: '#/components/schemas/Instance' examples: Updateinstance200Example: summary: Default updateInstance 200 response x-microcks-default: true value: id: abc123 compartmentId: '500123' availabilityDomain: example_value faultDomain: example_value displayName: example_value shape: example_value shapeConfig: ocpus: 42.5 memoryInGBs: 42.5 baselineOcpuUtilization: BASELINE_1_8 processorDescription: example_value networkingBandwidthInGbps: 42.5 maxVnicAttachments: 10 gpus: 10 gpuDescription: example_value localDisks: 10 localDisksTotalSizeInGBs: 42.5 vcpus: 10 region: example_value imageId: '500123' sourceDetails: sourceType: image imageId: '500123' bootVolumeId: '500123' bootVolumeSizeInGBs: 10 bootVolumeVpusPerGB: 10 lifecycleState: MOVING timeCreated: '2026-01-15T10:30:00Z' metadata: example_value extendedMetadata: example_value launchMode: NATIVE launchOptions: bootVolumeType: ISCSI firmware: BIOS networkType: E1000 remoteDataVolumeType: ISCSI isPvEncryptionInTransitEnabled: true isConsistentVolumeNamingEnabled: true agentConfig: isMonitoringDisabled: true isManagementDisabled: true areAllPluginsDisabled: true pluginsConfig: - {} availabilityConfig: isLiveMigrationPreferred: true recoveryAction: RESTORE_INSTANCE platformConfig: type: AMD_MILAN_BM isSecureBootEnabled: true isTrustedPlatformModuleEnabled: true isMeasuredBootEnabled: true isMemoryEncryptionEnabled: true timeMaintenanceRebootDue: '2026-01-15T10:30:00Z' capacityReservationId: '500123' dedicatedVmHostId: '500123' isCrossNumaNode: true definedTags: {} freeformTags: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '412': $ref: '#/components/responses/PreconditionFailed' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: terminateInstance summary: Oracle Terminate an Instance description: >- Permanently terminates (deletes) the specified instance. Any attached VNICs and volumes are automatically detached when the instance terminates. You can optionally choose to preserve the boot volume associated with the instance. tags: - Instances parameters: - $ref: '#/components/parameters/instanceId' - $ref: '#/components/parameters/ifMatch' - name: preserveBootVolume in: query description: >- Specifies whether to delete or preserve the boot volume when terminating an instance. Defaults to false (delete the boot volume). schema: type: boolean default: false example: true - name: preserveDataVolumesCreatedAtLaunch in: query description: >- Specifies whether to delete or preserve data volumes created during launch when terminating an instance. Defaults to true (preserve). schema: type: boolean default: true example: true responses: '204': description: The instance is being terminated headers: opc-request-id: description: Unique Oracle-assigned identifier for the request schema: type: string '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '412': $ref: '#/components/responses/PreconditionFailed' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instances/{instanceId}/actions/{action}: post: operationId: instanceAction summary: Oracle Perform an Action on an Instance description: >- Performs an action on the specified instance, such as starting, stopping, resetting, or soft-resetting the instance. The STOP action is equivalent to pressing the power button. The SOFTRESET action gracefully reboots the instance by sending an ACPI shutdown and then powering back on. tags: - Instances parameters: - $ref: '#/components/parameters/instanceId' - name: action in: path required: true description: The action to perform on the instance schema: type: string enum: - STOP - START - SOFTRESET - RESET - SOFTSTOP - SENDDIAGNOSTICINTERRUPT - DIAGNOSTICREBOOT - REBOOTMIGRATE example: STOP - $ref: '#/components/parameters/ifMatch' responses: '200': description: The action was performed on the instance headers: etag: description: Entity tag for the instance resource schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request schema: type: string content: application/json: schema: $ref: '#/components/schemas/Instance' examples: Instanceaction200Example: summary: Default instanceAction 200 response x-microcks-default: true value: id: abc123 compartmentId: '500123' availabilityDomain: example_value faultDomain: example_value displayName: example_value shape: example_value shapeConfig: ocpus: 42.5 memoryInGBs: 42.5 baselineOcpuUtilization: BASELINE_1_8 processorDescription: example_value networkingBandwidthInGbps: 42.5 maxVnicAttachments: 10 gpus: 10 gpuDescription: example_value localDisks: 10 localDisksTotalSizeInGBs: 42.5 vcpus: 10 region: example_value imageId: '500123' sourceDetails: sourceType: image imageId: '500123' bootVolumeId: '500123' bootVolumeSizeInGBs: 10 bootVolumeVpusPerGB: 10 lifecycleState: MOVING timeCreated: '2026-01-15T10:30:00Z' metadata: example_value extendedMetadata: example_value launchMode: NATIVE launchOptions: bootVolumeType: ISCSI firmware: BIOS networkType: E1000 remoteDataVolumeType: ISCSI isPvEncryptionInTransitEnabled: true isConsistentVolumeNamingEnabled: true agentConfig: isMonitoringDisabled: true isManagementDisabled: true areAllPluginsDisabled: true pluginsConfig: - {} availabilityConfig: isLiveMigrationPreferred: true recoveryAction: RESTORE_INSTANCE platformConfig: type: AMD_MILAN_BM isSecureBootEnabled: true isTrustedPlatformModuleEnabled: true isMeasuredBootEnabled: true isMemoryEncryptionEnabled: true timeMaintenanceRebootDue: '2026-01-15T10:30:00Z' capacityReservationId: '500123' dedicatedVmHostId: '500123' isCrossNumaNode: true definedTags: {} freeformTags: {} '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '412': $ref: '#/components/responses/PreconditionFailed' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /shapes: get: operationId: listShapes summary: Oracle List Shapes description: >- Lists the shapes that can be used to launch an instance within the specified compartment. Shapes determine the number of CPUs, amount of memory, and other resources allocated to an instance. You can filter the list by compatibility with a specific image. tags: - Shapes parameters: - $ref: '#/components/parameters/compartmentId' - name: availabilityDomain in: query description: >- The name of the availability domain. If not specified, shapes across all availability domains in the compartment are listed. schema: type: string example: example_value - name: imageId in: query description: >- The OCID of an image. If specified, only shapes compatible with the image are returned. schema: type: string example: '500123' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/page' responses: '200': description: The list of shapes headers: opc-next-page: description: >- For pagination. When this header appears in the response, additional pages of results remain. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request schema: type: string content: application/json: schema: type: array items: $ref: '#/components/schemas/Shape' examples: Listshapes200Example: summary: Default listShapes 200 response x-microcks-default: true value: - shape: example_value availabilityDomain: example_value ocpus: 42.5 memoryInGBs: 42.5 processorDescription: example_value networkingBandwidthInGbps: 42.5 maxVnicAttachments: 10 gpus: 10 gpuDescription: example_value localDisks: 10 localDisksTotalSizeInGBs: 42.5 localDiskDescription: example_value isFlexible: true ocpuOptions: min: 42.5 max: 42.5 maxPerNumaNode: 42.5 memoryOptions: minInGBs: 42.5 maxInGBs: 42.5 defaultPerOcpuInGBs: 42.5 minPerOcpuInGBs: 42.5 maxPerOcpuInGBs: 42.5 networkingBandwidthOptions: minInGbps: 42.5 maxInGbps: 42.5 defaultPerOcpuInGbps: 42.5 maxVnicAttachmentOptions: min: 10 max: 42.5 defaultPerOcpu: 42.5 isBilledForStoppedInstance: true quotaNames: - example_value recommendedAlternatives: - shapeName: example_value platformConfigOptions: type: example_value isSecureBootEnabled: true isTrustedPlatformModuleEnabled: true isMeasuredBootEnabled: true isMemoryEncryptionEnabled: true '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /images: get: operationId: listImages summary: Oracle List Images description: >- Lists a subset of images available in the specified compartment, including platform images, custom images, and Marketplace partner images. You can filter the results by display name, operating system, lifecycle state, and shape compatibility. tags: - Images parameters: - $ref: '#/components/parameters/compartmentId' - name: displayName in: query description: A filter to return only resources that match the given display name exactly schema: type: string example: example_value - name: operatingSystem in: query description: The image operating system (e.g., Oracle Linux) schema: type: string example: example_value - name: operatingSystemVersion in: query description: The image operating system version (e.g., 8) schema: type: string example: example_value - name: shape in: query description: >- Shape name. If specified, only images compatible with the shape are returned. schema: type: string example: example_value - name: lifecycleState in: query description: A filter to return only images that match the given lifecycle state schema: $ref: '#/components/schemas/ImageLifecycleState' example: example_value - name: sortBy in: query description: The field to sort by schema: type: string enum: - TIMECREATED - DISPLAYNAME default: TIMECREATED example: TIMECREATED - $ref: '#/components/parameters/sortOrder' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/page' responses: '200': description: The list of images headers: opc-next-page: description: >- For pagination. When this header appears in the response, additional pages of results remain. schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request schema: type: string content: application/json: schema: type: array items: $ref: '#/components/schemas/Image' examples: Listimages200Example: summary: Default listImages 200 response x-microcks-default: true value: - id: abc123 compartmentId: '500123' displayName: example_value operatingSystem: example_value operatingSystemVersion: example_value lifecycleState: PROVISIONING timeCreated: '2026-01-15T10:30:00Z' baseImageId: '500123' sizeInMBs: 10 billableSizeInGBs: 10 createImageAllowed: true agentFeatures: isMonitoringSupported: true isManagementSupported: true launchMode: NATIVE launchOptions: bootVolumeType: ISCSI firmware: BIOS networkType: E1000 remoteDataVolumeType: ISCSI isPvEncryptionInTransitEnabled: true isConsistentVolumeNamingEnabled: true listingType: COMMUNITY definedTags: {} freeformTags: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createImage summary: Oracle Create an Image description: >- Creates a boot disk image for the specified instance or imports an image from an Object Storage URL. The image can then be used to launch new instances. When creating from an instance, the instance must be in the STOPPED state. tags: - Images parameters: - $ref: '#/components/parameters/opcRetryToken' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateImageDetails' examples: CreateimageRequestExample: summary: Default createImage request x-microcks-default: true value: compartmentId: '500123' displayName: example_value instanceId: '500123' imageSourceDetails: sourceType: objectStorageTuple bucketName: example_value namespaceName: example_value objectName: example_value sourceUri: example_value sourceImageType: QCOW2 operatingSystem: example_value operatingSystemVersion: example_value launchMode: NATIVE definedTags: {} freeformTags: {} responses: '200': description: The image was created successfully headers: etag: description: Entity tag for the image resource schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request schema: type: string opc-work-request-id: description: >- The OCID of the work request. Use GetWorkRequest to monitor the status of the image creation. schema: type: string content: application/json: schema: $ref: '#/components/schemas/Image' examples: Createimage200Example: summary: Default createImage 200 response x-microcks-default: true value: id: abc123 compartmentId: '500123' displayName: example_value operatingSystem: example_value operatingSystemVersion: example_value lifecycleState: PROVISIONING timeCreated: '2026-01-15T10:30:00Z' baseImageId: '500123' sizeInMBs: 10 billableSizeInGBs: 10 createImageAllowed: true agentFeatures: isMonitoringSupported: true isManagementSupported: true launchMode: NATIVE launchOptions: bootVolumeType: ISCSI firmware: BIOS networkType: E1000 remoteDataVolumeType: ISCSI isPvEncryptionInTransitEnabled: true isConsistentVolumeNamingEnabled: true listingType: COMMUNITY definedTags: {} freeformTags: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /images/{imageId}: get: operationId: getImage summary: Oracle Get an Image description: Gets the specified image, including its display name, lifecycle state, operating system, and size. tags: - Images parameters: - $ref: '#/components/parameters/imageId' responses: '200': description: The image details headers: etag: description: Entity tag for the image resource schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request schema: type: string content: application/json: schema: $ref: '#/components/schemas/Image' examples: Getimage200Example: summary: Default getImage 200 response x-microcks-default: true value: id: abc123 compartmentId: '500123' displayName: example_value operatingSystem: example_value operatingSystemVersion: example_value lifecycleState: PROVISIONING timeCreated: '2026-01-15T10:30:00Z' baseImageId: '500123' sizeInMBs: 10 billableSizeInGBs: 10 createImageAllowed: true agentFeatures: isMonitoringSupported: true isManagementSupported: true launchMode: NATIVE launchOptions: bootVolumeType: ISCSI firmware: BIOS networkType: E1000 remoteDataVolumeType: ISCSI isPvEncryptionInTransitEnabled: true isConsistentVolumeNamingEnabled: true listingType: COMMUNITY definedTags: {} freeformTags: {} '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: updateImage summary: Oracle Update an Image description: >- Updates the display name and tags of the specified image. Avoid entering confidential information. tags: - Images parameters: - $ref: '#/components/parameters/imageId' - $ref: '#/components/parameters/ifMatch' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateImageDetails' examples: UpdateimageRequestExample: summary: Default updateImage request x-microcks-default: true value: displayName: example_value definedTags: {} freeformTags: {} responses: '200': description: The image was updated successfully headers: etag: description: Entity tag for the updated image resource schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request schema: type: string content: application/json: schema: $ref: '#/components/schemas/Image' examples: Updateimage200Example: summary: Default updateImage 200 response x-microcks-default: true value: id: abc123 compartmentId: '500123' displayName: example_value operatingSystem: example_value operatingSystemVersion: example_value lifecycleState: PROVISIONING timeCreated: '2026-01-15T10:30:00Z' baseImageId: '500123' sizeInMBs: 10 billableSizeInGBs: 10 createImageAllowed: true agentFeatures: isMonitoringSupported: true isManagementSupported: true launchMode: NATIVE launchOptions: bootVolumeType: ISCSI firmware: BIOS networkType: E1000 remoteDataVolumeType: ISCSI isPvEncryptionInTransitEnabled: true isConsistentVolumeNamingEnabled: true listingType: COMMUNITY definedTags: {} freeformTags: {} '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '412': $ref: '#/components/responses/PreconditionFailed' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: operationId: deleteImage summary: Oracle Delete an Image description: >- Deletes the specified image. Note that platform images provided by Oracle cannot be deleted. tags: - Images parameters: - $ref: '#/components/parameters/imageId' - $ref: '#/components/parameters/ifMatch' responses: '204': description: The image is being deleted headers: opc-request-id: description: Unique Oracle-assigned identifier for the request schema: type: string '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '412': $ref: '#/components/responses/PreconditionFailed' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /vnicAttachments: get: operationId: listVnicAttachments summary: Oracle List Vnic Attachments description: >- Lists the VNIC attachments in the specified compartment. A VNIC attachment represents the connection between an instance and a VNIC. tags: - VNIC Attachments parameters: - $ref: '#/components/parameters/compartmentId' - name: instanceId in: query description: The OCID of the instance to filter by schema: type: string example: '500123' - name: availabilityDomain in: query description: The name of the availability domain to filter by schema: type: string example: example_value - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/page' responses: '200': description: The list of VNIC attachments headers: opc-next-page: description: Pagination token for the next page of results schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request schema: type: string content: application/json: schema: type: array items: $ref: '#/components/schemas/VnicAttachment' examples: Listvnicattachments200Example: summary: Default listVnicAttachments 200 response x-microcks-default: true value: - id: abc123 instanceId: '500123' compartmentId: '500123' availabilityDomain: example_value displayName: example_value vnicId: '500123' subnetId: '500123' nicIndex: 10 vlanTag: 10 vlanId: '500123' lifecycleState: ATTACHING timeCreated: '2026-01-15T10:30:00Z' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /volumeAttachments: get: operationId: listVolumeAttachments summary: Oracle List Volume Attachments description: >- Lists the volume attachments in the specified compartment. You can filter by instance OCID or volume OCID. tags: - Volume Attachments parameters: - $ref: '#/components/parameters/compartmentId' - name: instanceId in: query description: The OCID of the instance to filter by schema: type: string example: '500123' - name: volumeId in: query description: The OCID of the volume to filter by schema: type: string example: '500123' - name: availabilityDomain in: query description: The name of the availability domain to filter by schema: type: string example: example_value - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/page' responses: '200': description: The list of volume attachments headers: opc-next-page: description: Pagination token for the next page of results schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request schema: type: string content: application/json: schema: type: array items: $ref: '#/components/schemas/VolumeAttachment' examples: Listvolumeattachments200Example: summary: Default listVolumeAttachments 200 response x-microcks-default: true value: - id: abc123 instanceId: '500123' volumeId: '500123' compartmentId: '500123' availabilityDomain: example_value displayName: example_value device: example_value attachmentType: iscsi lifecycleState: ATTACHING timeCreated: '2026-01-15T10:30:00Z' isReadOnly: true isShareable: true isPvEncryptionInTransitEnabled: true isMultipath: true iscsiLoginState: UNKNOWN '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instanceConsoleConnections: get: operationId: listInstanceConsoleConnections summary: Oracle List Instance Console Connections description: >- Lists the console connections for the specified compartment or instance. Console connections enable you to troubleshoot instances by connecting to the serial console or VNC console. tags: - Console Connections parameters: - $ref: '#/components/parameters/compartmentId' - name: instanceId in: query description: The OCID of the instance to filter by schema: type: string example: '500123' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/page' responses: '200': description: The list of console connections headers: opc-next-page: description: Pagination token for the next page of results schema: type: string opc-request-id: description: Unique Oracle-assigned identifier for the request schema: type: string content: application/json: schema: type: array items: $ref: '#/components/schemas/InstanceConsoleConnection' examples: Listinstanceconsoleconnections200Example: summary: Default listInstanceConsoleConnections 200 response x-microcks-default: true value: - id: abc123 instanceId: '500123' compartmentId: '500123' connectionString: example_value fingerprint: example_value vncConnectionString: example_value lifecycleState: ACTIVE serviceHostKeyFingerprint: example_value definedTags: {} freeformTags: {} '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' x-microcks-operation: delay: 0 dispatcher: FALLBACK components: securitySchemes: ociRequestSigning: type: http scheme: bearer description: >- OCI uses a custom request signing scheme based on RSA key pairs. Each API request must include an Authorization header with the signature computed from the request headers, method, and path. See https://docs.oracle.com/en-us/iaas/Content/API/Concepts/signingrequests.htm parameters: compartmentId: name: compartmentId in: query required: true description: >- The OCID of the compartment. List operations return resources in the compartment and its sub-compartments unless specified otherwise. schema: type: string instanceId: name: instanceId in: path required: true description: The OCID of the instance schema: type: string imageId: name: imageId in: path required: true description: The OCID of the image schema: type: string limit: name: limit in: query description: >- For list pagination. The maximum number of results per page, or items to return in a paginated list call. The value must be between 1 and 1000. schema: type: integer minimum: 1 maximum: 1000 default: 100 page: name: page in: query description: >- For list pagination. The value of the opc-next-page response header from the previous list call. schema: type: string sortBy: name: sortBy in: query description: The field to sort by schema: type: string enum: - TIMECREATED - DISPLAYNAME default: TIMECREATED sortOrder: name: sortOrder in: query description: The sort order, either ascending or descending schema: type: string enum: - ASC - DESC default: DESC ifMatch: name: if-match in: header description: >- For optimistic concurrency control. The entity tag (ETag) of the resource to match. The request succeeds only if the ETag you provide matches the current ETag value of the resource. schema: type: string opcRetryToken: name: opc-retry-token in: header description: >- A token that uniquely identifies a request so it can be retried in case of a timeout or server error. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. schema: type: string schemas: Instance: type: object description: >- A compute instance is a virtual machine (VM) or bare metal host running in Oracle Cloud Infrastructure. It includes information about the shape, image, networking, and lifecycle state. required: - id - compartmentId - availabilityDomain - shape - region - lifecycleState - timeCreated properties: id: type: string description: The OCID of the instance examples: - ocid1.instance.oc1.phx.abcdefghijklmnop compartmentId: type: string description: The OCID of the compartment containing the instance example: '500123' availabilityDomain: type: string description: >- The availability domain the instance is running in (e.g., Uocm:PHX-AD-1) example: example_value faultDomain: type: string description: >- The fault domain the instance is running in. A fault domain is a grouping of hardware and infrastructure within an availability domain. example: example_value displayName: type: string description: >- A user-friendly name. Does not have to be unique, and it is changeable. Avoid entering confidential information. example: example_value shape: type: string description: >- The shape of the instance. The shape determines the number of CPUs, amount of memory, and other resources allocated. examples: - VM.Standard.E4.Flex - VM.Standard3.Flex - BM.Standard3.64 shapeConfig: $ref: '#/components/schemas/InstanceShapeConfig' region: type: string description: >- The region that contains the availability domain the instance is running in examples: - us-ashburn-1 imageId: type: string description: >- Deprecated. Use sourceDetails instead. The OCID of the image used to boot the instance. example: '500123' sourceDetails: $ref: '#/components/schemas/InstanceSourceDetails' lifecycleState: $ref: '#/components/schemas/InstanceLifecycleState' timeCreated: type: string format: date-time description: >- The date and time the instance was created, in the format defined by RFC 3339. example: '2026-01-15T10:30:00Z' metadata: type: object additionalProperties: type: string description: >- Custom metadata key/value pairs. The metadata can include ssh_authorized_keys and user_data for cloud-init. example: example_value extendedMetadata: type: object additionalProperties: true description: >- Additional metadata key/value pairs that can contain nested JSON objects. example: example_value launchMode: type: string description: >- Specifies the configuration mode for launching VM instances. enum: - NATIVE - EMULATED - PARAVIRTUALIZED - CUSTOM example: NATIVE launchOptions: $ref: '#/components/schemas/LaunchOptions' agentConfig: $ref: '#/components/schemas/InstanceAgentConfig' availabilityConfig: $ref: '#/components/schemas/InstanceAvailabilityConfig' platformConfig: $ref: '#/components/schemas/PlatformConfig' timeMaintenanceRebootDue: type: string format: date-time description: >- The date and time the instance is expected to be stopped or migrated for infrastructure maintenance, if applicable. example: '2026-01-15T10:30:00Z' capacityReservationId: type: string description: >- The OCID of the compute capacity reservation this instance is launched under, if applicable. example: '500123' dedicatedVmHostId: type: string description: >- The OCID of the dedicated virtual machine host that the instance is placed on, if applicable. example: '500123' isCrossNumaNode: type: boolean description: Whether the instance spans multiple NUMA nodes example: true definedTags: $ref: '#/components/schemas/DefinedTags' freeformTags: $ref: '#/components/schemas/FreeformTags' InstanceLifecycleState: type: string description: The lifecycle state of a compute instance enum: - MOVING - PROVISIONING - RUNNING - STARTING - STOPPING - STOPPED - CREATING_IMAGE - TERMINATING - TERMINATED InstanceShapeConfig: type: object description: >- The shape configuration for an instance. This includes the number of OCPUs, amount of memory, and networking bandwidth. properties: ocpus: type: number format: float description: The total number of OCPUs available to the instance example: 42.5 memoryInGBs: type: number format: float description: The total amount of memory available to the instance, in gigabytes example: 42.5 baselineOcpuUtilization: type: string description: >- The baseline OCPU utilization for a subcore burstable instance enum: - BASELINE_1_8 - BASELINE_1_2 - BASELINE_1_1 example: BASELINE_1_8 processorDescription: type: string description: A short description of the instance processor example: example_value networkingBandwidthInGbps: type: number format: float description: The networking bandwidth available to the instance, in Gbps example: 42.5 maxVnicAttachments: type: integer description: The maximum number of VNIC attachments for the instance example: 10 gpus: type: integer description: The number of GPUs available to the instance example: 10 gpuDescription: type: string description: A short description of the instance GPU example: example_value localDisks: type: integer description: The number of local disks available to the instance example: 10 localDisksTotalSizeInGBs: type: number format: float description: >- The aggregate size of all local disks, in gigabytes example: 42.5 vcpus: type: integer description: >- The total number of VCPUs available to the instance. This is typically 2x the number of OCPUs. example: 10 InstanceSourceDetails: type: object description: Details for creating an instance source required: - sourceType properties: sourceType: type: string description: The source type for the instance enum: - image - bootVolume example: image imageId: type: string description: The OCID of the image used to boot the instance example: '500123' bootVolumeId: type: string description: The OCID of the boot volume used to boot the instance example: '500123' bootVolumeSizeInGBs: type: integer description: >- The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB). minimum: 50 maximum: 32768 example: 10 bootVolumeVpusPerGB: type: integer description: >- The number of volume performance units (VPUs) per GB for the boot volume. Values range from 10 to 120. The default is 10 (Balanced). minimum: 10 maximum: 120 default: 10 example: 10 LaunchInstanceDetails: type: object description: >- Instance launch details. Use this to provide the necessary configuration when launching a new compute instance. required: - compartmentId - availabilityDomain - shape properties: compartmentId: type: string description: The OCID of the compartment to create the instance in example: '500123' availabilityDomain: type: string description: The availability domain of the instance (e.g., Uocm:PHX-AD-1) example: example_value displayName: type: string description: >- A user-friendly name for the instance. Does not have to be unique. Avoid entering confidential information. example: example_value shape: type: string description: >- The shape of the instance. The shape determines the number of CPUs and amount of memory allocated to the instance. examples: - VM.Standard.E4.Flex - VM.Standard3.Flex shapeConfig: $ref: '#/components/schemas/LaunchInstanceShapeConfigDetails' sourceDetails: $ref: '#/components/schemas/InstanceSourceDetails' createVnicDetails: $ref: '#/components/schemas/CreateVnicDetails' metadata: type: object additionalProperties: type: string description: >- Custom metadata key/value pairs for the instance. Common keys include ssh_authorized_keys and user_data. example: example_value extendedMetadata: type: object additionalProperties: true description: >- Additional metadata key/value pairs that can contain nested JSON. example: example_value faultDomain: type: string description: >- A fault domain is a grouping of hardware and infrastructure within an availability domain. Specify the fault domain to place the instance in, or let the system choose one for you. example: example_value launchOptions: $ref: '#/components/schemas/LaunchOptions' agentConfig: $ref: '#/components/schemas/LaunchInstanceAgentConfigDetails' availabilityConfig: $ref: '#/components/schemas/LaunchInstanceAvailabilityConfigDetails' platformConfig: $ref: '#/components/schemas/LaunchInstancePlatformConfig' isPvEncryptionInTransitEnabled: type: boolean description: >- Whether to enable in-transit encryption for the data volume's paravirtualized attachment default: false example: true capacityReservationId: type: string description: The OCID of the capacity reservation to launch the instance into example: '500123' dedicatedVmHostId: type: string description: The OCID of the dedicated VM host to place the instance on example: '500123' definedTags: $ref: '#/components/schemas/DefinedTags' freeformTags: $ref: '#/components/schemas/FreeformTags' LaunchInstanceShapeConfigDetails: type: object description: >- The shape configuration details for launching a flexible instance. Required when using a flexible shape (e.g., VM.Standard.E4.Flex). properties: ocpus: type: number format: float description: >- The total number of OCPUs available to the instance. For flexible shapes, specify the desired number of OCPUs. minimum: 1 example: 42.5 memoryInGBs: type: number format: float description: >- The total amount of memory in gigabytes. For flexible shapes, the amount of memory per OCPU can vary. The default ratio is typically 1 OCPU to 16 GB of memory. example: 42.5 baselineOcpuUtilization: type: string description: >- The baseline OCPU utilization for a subcore burstable instance. Leave unset for a non-burstable instance or to use the default baseline. enum: - BASELINE_1_8 - BASELINE_1_2 - BASELINE_1_1 example: BASELINE_1_8 nvmes: type: integer description: The number of NVMe drives to attach to the instance example: 10 UpdateInstanceDetails: type: object description: Details for updating an instance properties: displayName: type: string description: >- A user-friendly name. Does not have to be unique. Avoid entering confidential information. example: example_value shape: type: string description: >- The shape of the instance. Changing the shape requires the instance to be stopped first. example: example_value shapeConfig: $ref: '#/components/schemas/LaunchInstanceShapeConfigDetails' metadata: type: object additionalProperties: type: string description: Custom metadata key/value pairs example: example_value extendedMetadata: type: object additionalProperties: true description: Additional metadata key/value pairs example: example_value agentConfig: $ref: '#/components/schemas/LaunchInstanceAgentConfigDetails' availabilityConfig: $ref: '#/components/schemas/LaunchInstanceAvailabilityConfigDetails' faultDomain: type: string description: The fault domain for the instance example: example_value definedTags: $ref: '#/components/schemas/DefinedTags' freeformTags: $ref: '#/components/schemas/FreeformTags' CreateVnicDetails: type: object description: >- Contains properties for a VNIC. Used when launching an instance or creating a VNIC attachment. required: - subnetId properties: subnetId: type: string description: The OCID of the subnet to create the VNIC in example: '500123' displayName: type: string description: >- A user-friendly name for the VNIC. Does not have to be unique. example: example_value assignPublicIp: type: boolean description: >- Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. example: true assignPrivateDnsRecord: type: boolean description: >- Whether the VNIC should be assigned a DNS record. Defaults to true. default: true example: true privateIp: type: string description: >- A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet CIDR. example: example_value hostnameLabel: type: string description: >- The hostname for the VNIC primary private IP. Used for DNS. example: example_value nsgIds: type: array description: A list of the OCIDs of the network security groups to add the VNIC to items: type: string example: [] skipSourceDestCheck: type: boolean description: >- Whether the source/destination check is disabled on the VNIC. Defaults to false. default: false example: true definedTags: $ref: '#/components/schemas/DefinedTags' freeformTags: $ref: '#/components/schemas/FreeformTags' LaunchOptions: type: object description: Options for tuning the compatibility and performance of VM shapes properties: bootVolumeType: type: string description: >- Emulation type for the boot volume. PARAVIRTUALIZED is recommended for best performance. enum: - ISCSI - SCSI - IDE - VFIO - PARAVIRTUALIZED example: ISCSI firmware: type: string description: Firmware used to boot the VM enum: - BIOS - UEFI_64 example: BIOS networkType: type: string description: >- Emulation type for the physical network interface card (NIC). PARAVIRTUALIZED or VFIO is recommended. enum: - E1000 - VFIO - PARAVIRTUALIZED example: E1000 remoteDataVolumeType: type: string description: Emulation type for attached block volume data disks enum: - ISCSI - SCSI - IDE - VFIO - PARAVIRTUALIZED example: ISCSI isPvEncryptionInTransitEnabled: type: boolean description: >- Whether to enable in-transit encryption for the data volume's paravirtualized attachment example: true isConsistentVolumeNamingEnabled: type: boolean description: Whether to enable consistent volume naming example: true InstanceAgentConfig: type: object description: Configuration options for the Oracle Cloud Agent software properties: isMonitoringDisabled: type: boolean description: Whether the Monitoring plugin is disabled example: true isManagementDisabled: type: boolean description: Whether the Management plugin is disabled example: true areAllPluginsDisabled: type: boolean description: Whether all plugins are disabled example: true pluginsConfig: type: array description: The configuration of plugins associated with this instance items: $ref: '#/components/schemas/InstanceAgentPluginConfigDetails' example: [] InstanceAgentPluginConfigDetails: type: object description: Configuration details for an Oracle Cloud Agent plugin required: - name - desiredState properties: name: type: string description: The plugin name (e.g., Vulnerability Scanning, Bastion) example: Example Title desiredState: type: string description: Whether the plugin should be enabled or disabled enum: - ENABLED - DISABLED example: ENABLED LaunchInstanceAgentConfigDetails: type: object description: Configuration options for the Oracle Cloud Agent on launch properties: isMonitoringDisabled: type: boolean description: Whether to disable the Monitoring plugin default: false example: true isManagementDisabled: type: boolean description: Whether to disable the Management plugin default: false example: true areAllPluginsDisabled: type: boolean description: Whether to disable all plugins default: false example: true pluginsConfig: type: array description: Plugin configuration details items: $ref: '#/components/schemas/InstanceAgentPluginConfigDetails' example: [] InstanceAvailabilityConfig: type: object description: Options for VM migration during infrastructure maintenance properties: isLiveMigrationPreferred: type: boolean description: Whether live migration is the preferred option during maintenance example: true recoveryAction: type: string description: >- The lifecycle state for an instance when maintenance is due enum: - RESTORE_INSTANCE - STOP_INSTANCE example: RESTORE_INSTANCE LaunchInstanceAvailabilityConfigDetails: type: object description: Options for VM migration during infrastructure maintenance on launch properties: isLiveMigrationPreferred: type: boolean description: Whether live migration is the preferred option example: true recoveryAction: type: string description: The lifecycle state for an instance when maintenance is due enum: - RESTORE_INSTANCE - STOP_INSTANCE example: RESTORE_INSTANCE PlatformConfig: type: object description: >- The platform configuration for the instance. Includes settings for Secure Boot, measured boot, and trusted platform module. properties: type: type: string description: The type of platform configuration enum: - AMD_MILAN_BM - AMD_MILAN_BM_GPU - AMD_ROME_BM - AMD_ROME_BM_GPU - AMD_VM - GENERIC_BM - INTEL_ICELAKE_BM - INTEL_SKYLAKE_BM - INTEL_VM example: AMD_MILAN_BM isSecureBootEnabled: type: boolean description: Whether Secure Boot is enabled on the instance example: true isTrustedPlatformModuleEnabled: type: boolean description: Whether the Trusted Platform Module (TPM) is enabled example: true isMeasuredBootEnabled: type: boolean description: Whether the Measured Boot feature is enabled example: true isMemoryEncryptionEnabled: type: boolean description: Whether AMD memory encryption is enabled example: true LaunchInstancePlatformConfig: type: object description: The platform configuration for launching an instance properties: type: type: string description: The type of platform configuration enum: - AMD_MILAN_BM - AMD_MILAN_BM_GPU - AMD_ROME_BM - AMD_ROME_BM_GPU - AMD_VM - GENERIC_BM - INTEL_ICELAKE_BM - INTEL_SKYLAKE_BM - INTEL_VM example: AMD_MILAN_BM isSecureBootEnabled: type: boolean description: Whether Secure Boot is enabled example: true isTrustedPlatformModuleEnabled: type: boolean description: Whether the Trusted Platform Module is enabled example: true isMeasuredBootEnabled: type: boolean description: Whether Measured Boot is enabled example: true isMemoryEncryptionEnabled: type: boolean description: Whether AMD memory encryption is enabled example: true Shape: type: object description: >- A compute shape that can be used to launch an instance. A shape determines the type of resources allocated, including CPUs, memory, and networking bandwidth. required: - shape properties: shape: type: string description: The name of the shape examples: - VM.Standard.E4.Flex - VM.Standard3.Flex - BM.Standard3.64 - VM.GPU.A10.1 - VM.DenseIO.E4.Flex availabilityDomain: type: string description: >- The availability domain where the shape is available. Null if the shape is available across all availability domains. example: example_value ocpus: type: number format: float description: >- The default number of OCPUs available for this shape. For flexible shapes, this is the default when not specifying a custom value. example: 42.5 memoryInGBs: type: number format: float description: The default amount of memory available for this shape, in GB example: 42.5 processorDescription: type: string description: A short description of the processor examples: - 2.55 GHz AMD EPYC 7J13 (Milan) - 2.0 GHz Intel Xeon Platinum 8167M (Skylake) networkingBandwidthInGbps: type: number format: float description: The networking bandwidth available for this shape, in Gbps example: 42.5 maxVnicAttachments: type: integer description: The maximum number of VNICs that can be attached example: 10 gpus: type: integer description: The number of GPUs available for this shape example: 10 gpuDescription: type: string description: A short description of the GPU example: example_value localDisks: type: integer description: The number of local disks available for this shape example: 10 localDisksTotalSizeInGBs: type: number format: float description: The aggregate size of local disks in GB example: 42.5 localDiskDescription: type: string description: A short description of the local disks example: example_value isFlexible: type: boolean description: Whether the shape supports flexible OCPU and memory configuration example: true ocpuOptions: $ref: '#/components/schemas/ShapeOcpuOptions' memoryOptions: $ref: '#/components/schemas/ShapeMemoryOptions' networkingBandwidthOptions: $ref: '#/components/schemas/ShapeNetworkingBandwidthOptions' maxVnicAttachmentOptions: $ref: '#/components/schemas/ShapeMaxVnicAttachmentOptions' isBilledForStoppedInstance: type: boolean description: Whether billing continues when the instance using this shape is stopped example: true quotaNames: type: array description: The list of quota names associated with this shape items: type: string example: [] recommendedAlternatives: type: array description: The list of shapes recommended as alternatives items: type: object properties: shapeName: type: string description: The name of the alternative shape example: [] platformConfigOptions: $ref: '#/components/schemas/ShapePlatformConfigOptions' ShapeOcpuOptions: type: object description: Options for configuring OCPUs on a flexible shape properties: min: type: number format: float description: The minimum number of OCPUs example: 42.5 max: type: number format: float description: The maximum number of OCPUs example: 42.5 maxPerNumaNode: type: number format: float description: The maximum number of OCPUs per NUMA node example: 42.5 ShapeMemoryOptions: type: object description: Options for configuring memory on a flexible shape properties: minInGBs: type: number format: float description: The minimum amount of memory, in GB example: 42.5 maxInGBs: type: number format: float description: The maximum amount of memory, in GB example: 42.5 defaultPerOcpuInGBs: type: number format: float description: The default amount of memory per OCPU, in GB example: 42.5 minPerOcpuInGBs: type: number format: float description: The minimum amount of memory per OCPU, in GB example: 42.5 maxPerOcpuInGBs: type: number format: float description: The maximum amount of memory per OCPU, in GB example: 42.5 ShapeNetworkingBandwidthOptions: type: object description: Options for configuring networking bandwidth on a flexible shape properties: minInGbps: type: number format: float description: The minimum networking bandwidth, in Gbps example: 42.5 maxInGbps: type: number format: float description: The maximum networking bandwidth, in Gbps example: 42.5 defaultPerOcpuInGbps: type: number format: float description: The default networking bandwidth per OCPU, in Gbps example: 42.5 ShapeMaxVnicAttachmentOptions: type: object description: Options for configuring max VNIC attachments on a flexible shape properties: min: type: integer description: The minimum number of VNIC attachments example: 10 max: type: number format: float description: The maximum number of VNIC attachments example: 42.5 defaultPerOcpu: type: number format: float description: The default number of VNIC attachments per OCPU example: 42.5 ShapePlatformConfigOptions: type: object description: Platform configuration options available for the shape properties: type: type: string description: The type of platform configuration example: example_value isSecureBootEnabled: type: boolean description: Whether Secure Boot is supported example: true isTrustedPlatformModuleEnabled: type: boolean description: Whether the Trusted Platform Module is supported example: true isMeasuredBootEnabled: type: boolean description: Whether Measured Boot is supported example: true isMemoryEncryptionEnabled: type: boolean description: Whether memory encryption is supported example: true Image: type: object description: >- A boot disk image for launching compute instances. Images can be platform images provided by Oracle, custom images, or Marketplace partner images. required: - id - compartmentId - operatingSystem - operatingSystemVersion - lifecycleState - timeCreated properties: id: type: string description: The OCID of the image examples: - ocid1.image.oc1.phx.abcdefghijklmnop compartmentId: type: string description: The OCID of the compartment containing the image example: '500123' displayName: type: string description: >- A user-friendly name for the image. It does not have to be unique, and it is changeable. example: example_value operatingSystem: type: string description: The image operating system (e.g., Oracle Linux) examples: - Oracle Linux - CentOS - Windows - Canonical Ubuntu operatingSystemVersion: type: string description: The image operating system version (e.g., 8, 9) examples: - '8' - '9' - Server 2019 Standard lifecycleState: $ref: '#/components/schemas/ImageLifecycleState' timeCreated: type: string format: date-time description: The date and time the image was created example: '2026-01-15T10:30:00Z' baseImageId: type: string description: >- The OCID of the image originally used to create this custom image example: '500123' sizeInMBs: type: integer description: The boot volume size for an instance launched from this image, in MBs example: 10 billableSizeInGBs: type: integer description: The billable size of the image in GBs example: 10 createImageAllowed: type: boolean description: Whether instances launched from this image can be used to create new images example: true agentFeatures: type: object description: Oracle Cloud Agent features supported on the image properties: isMonitoringSupported: type: boolean description: Whether the Monitoring plugin is supported isManagementSupported: type: boolean description: Whether the Management plugin is supported example: example_value launchMode: type: string description: The launch mode of instances created from this image enum: - NATIVE - EMULATED - PARAVIRTUALIZED - CUSTOM example: NATIVE launchOptions: $ref: '#/components/schemas/LaunchOptions' listingType: type: string description: The listing type of the image enum: - COMMUNITY - NONE example: COMMUNITY definedTags: $ref: '#/components/schemas/DefinedTags' freeformTags: $ref: '#/components/schemas/FreeformTags' ImageLifecycleState: type: string description: The lifecycle state of an image enum: - PROVISIONING - IMPORTING - AVAILABLE - EXPORTING - DISABLED - DELETED CreateImageDetails: type: object description: Details for creating an image required: - compartmentId properties: compartmentId: type: string description: The OCID of the compartment to create the image in example: '500123' displayName: type: string description: >- A user-friendly name for the image. Avoid entering confidential information. example: example_value instanceId: type: string description: >- The OCID of the instance to use as the basis for the image. Required if imageSourceDetails is not specified. example: '500123' imageSourceDetails: $ref: '#/components/schemas/ImageSourceDetails' launchMode: type: string description: The launch mode for instances created from this image enum: - NATIVE - EMULATED - PARAVIRTUALIZED - CUSTOM example: NATIVE definedTags: $ref: '#/components/schemas/DefinedTags' freeformTags: $ref: '#/components/schemas/FreeformTags' ImageSourceDetails: type: object description: Details for importing an image from Object Storage required: - sourceType properties: sourceType: type: string description: The source type for the image enum: - objectStorageTuple - objectStorageUri example: objectStorageTuple bucketName: type: string description: The Object Storage bucket name (for objectStorageTuple) example: example_value namespaceName: type: string description: The Object Storage namespace (for objectStorageTuple) example: example_value objectName: type: string description: The Object Storage object name (for objectStorageTuple) example: example_value sourceUri: type: string description: >- The Object Storage URL for the image (for objectStorageUri source type) example: example_value sourceImageType: type: string description: The format of the image to import enum: - QCOW2 - VMDK example: QCOW2 operatingSystem: type: string description: The operating system of the image example: example_value operatingSystemVersion: type: string description: The operating system version of the image example: example_value UpdateImageDetails: type: object description: Details for updating an image properties: displayName: type: string description: >- A user-friendly name for the image. Avoid entering confidential information. example: example_value definedTags: $ref: '#/components/schemas/DefinedTags' freeformTags: $ref: '#/components/schemas/FreeformTags' VnicAttachment: type: object description: >- Represents the attachment between an instance and a VNIC. Each instance has a primary VNIC attachment created during launch. required: - id - instanceId - compartmentId - availabilityDomain - lifecycleState - timeCreated properties: id: type: string description: The OCID of the VNIC attachment example: abc123 instanceId: type: string description: The OCID of the instance example: '500123' compartmentId: type: string description: The OCID of the compartment example: '500123' availabilityDomain: type: string description: The availability domain of the instance example: example_value displayName: type: string description: A user-friendly name for the attachment example: example_value vnicId: type: string description: The OCID of the VNIC example: '500123' subnetId: type: string description: The OCID of the subnet of the VNIC example: '500123' nicIndex: type: integer description: >- Which physical network interface card (NIC) the VNIC uses. 0 for the primary VNIC. example: 10 vlanTag: type: integer description: The Oracle-assigned VLAN tag of the VNIC attachment example: 10 vlanId: type: string description: The OCID of the VLAN to create the VNIC in example: '500123' lifecycleState: type: string description: The lifecycle state of the VNIC attachment enum: - ATTACHING - ATTACHED - DETACHING - DETACHED example: ATTACHING timeCreated: type: string format: date-time description: The date and time the VNIC attachment was created example: '2026-01-15T10:30:00Z' VolumeAttachment: type: object description: >- A base object for all types of volume attachments. Represents the attachment between a compute instance and a block volume. required: - id - instanceId - volumeId - compartmentId - availabilityDomain - attachmentType - lifecycleState - timeCreated properties: id: type: string description: The OCID of the volume attachment example: abc123 instanceId: type: string description: The OCID of the instance the volume is attached to example: '500123' volumeId: type: string description: The OCID of the volume example: '500123' compartmentId: type: string description: The OCID of the compartment example: '500123' availabilityDomain: type: string description: The availability domain of an instance example: example_value displayName: type: string description: A user-friendly name for the attachment example: example_value device: type: string description: The device name (e.g., /dev/oracleoci/oraclevdb) example: example_value attachmentType: type: string description: The type of volume attachment enum: - iscsi - paravirtualized - emulated example: iscsi lifecycleState: type: string description: The lifecycle state of the volume attachment enum: - ATTACHING - ATTACHED - DETACHING - DETACHED example: ATTACHING timeCreated: type: string format: date-time description: The date and time the volume was attached example: '2026-01-15T10:30:00Z' isReadOnly: type: boolean description: Whether the attachment was created in read-only mode example: true isShareable: type: boolean description: Whether the attachment should be created in shareable mode example: true isPvEncryptionInTransitEnabled: type: boolean description: Whether in-transit encryption is enabled for the attachment example: true isMultipath: type: boolean description: Whether the attachment is multipath example: true iscsiLoginState: type: string description: The iSCSI login state of the volume attachment enum: - UNKNOWN - LOGGING_IN - LOGIN_SUCCEEDED - LOGIN_FAILED - LOGGING_OUT - LOGOUT_SUCCEEDED - LOGOUT_FAILED example: UNKNOWN InstanceConsoleConnection: type: object description: >- The details for a console connection to an instance. A console connection enables you to connect to the serial console or VNC console of an instance for troubleshooting. required: - id - instanceId - compartmentId - lifecycleState properties: id: type: string description: The OCID of the console connection example: abc123 instanceId: type: string description: The OCID of the instance the console connection connects to example: '500123' compartmentId: type: string description: The OCID of the compartment example: '500123' connectionString: type: string description: The SSH connection string for the console connection example: example_value fingerprint: type: string description: The SSH public key fingerprint for the console connection example: example_value vncConnectionString: type: string description: The SSH connection string for the VNC console example: example_value lifecycleState: type: string description: The lifecycle state of the console connection enum: - ACTIVE - CREATING - DELETED - DELETING - FAILED example: ACTIVE serviceHostKeyFingerprint: type: string description: The SSH public key fingerprint of the service host example: example_value definedTags: $ref: '#/components/schemas/DefinedTags' freeformTags: $ref: '#/components/schemas/FreeformTags' DefinedTags: type: object description: >- Defined tags for the resource. Each key is predefined and scoped to a namespace. The value is a map of tag key/value pairs. additionalProperties: type: object additionalProperties: type: string FreeformTags: type: object description: >- Free-form tags for the resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. additionalProperties: type: string Error: type: object description: Error response returned by the OCI API required: - code - message properties: code: type: string description: >- A short error code that defines the error, meant for programmatic parsing example: example_value message: type: string description: A human-readable error string example: example_value status: type: integer description: The HTTP status code example: 10 opcRequestId: type: string description: Unique Oracle-assigned identifier for the request example: '500123' responses: BadRequest: description: Bad request - invalid parameters or missing required fields content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Unauthorized - missing or invalid authentication credentials content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: Not found - the specified resource does not exist content: application/json: schema: $ref: '#/components/schemas/Error' Conflict: description: Conflict - the resource is in a conflicting state for this operation content: application/json: schema: $ref: '#/components/schemas/Error' PreconditionFailed: description: Precondition failed - the ETag provided does not match the current resource content: application/json: schema: $ref: '#/components/schemas/Error' TooManyRequests: description: Too many requests - rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/Error' InternalServerError: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/Error'