openapi: 3.1.0
info:
  title: Oracle OCI Compute Console Connections Instances 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
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
security:
- ociRequestSigning: []
tags:
- name: Instances
  description: Manage compute instances including launch, terminate, and lifecycle operations
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
components:
  schemas:
    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
    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
    InstanceLifecycleState:
      type: string
      description: The lifecycle state of a compute instance
      enum:
      - MOVING
      - PROVISIONING
      - RUNNING
      - STARTING
      - STOPPING
      - STOPPED
      - CREATING_IMAGE
      - TERMINATING
      - TERMINATED
    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
    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
    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: []
    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: []
    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'
    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'
    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
    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
    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
    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
    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'
    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
    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'
    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
    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'
    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
  responses:
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request - invalid parameters or missing required fields
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    TooManyRequests:
      description: Too many requests - rate limit exceeded
      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'
    Unauthorized:
      description: Unauthorized - missing or invalid authentication credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    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
    instanceId:
      name: instanceId
      in: path
      required: true
      description: The OCID of the instance
      schema:
        type: string
    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
    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
    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
    sortOrder:
      name: sortOrder
      in: query
      description: The sort order, either ascending or descending
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: DESC
    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
    sortBy:
      name: sortBy
      in: query
      description: The field to sort by
      schema:
        type: string
        enum:
        - TIMECREATED
        - DISPLAYNAME
        default: TIMECREATED
  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
externalDocs:
  description: OCI Compute Service Documentation
  url: https://docs.oracle.com/en-us/iaas/Content/Compute/Concepts/computeoverview.htm