Oracle Cloud Infrastructure Images API

openapi: 3.0.3
info:
  title: Oracle Cloud Compute Alarms Images API
  description: Manage compute instances, images, shapes, and related resources in Oracle Cloud Infrastructure.
  version: '20160918'
  x-generated-from: documentation
  x-last-validated: '2026-04-18'
  contact:
    name: Oracle Cloud Infrastructure
    url: https://docs.oracle.com/en-us/iaas/Content/Compute/home.htm
servers:
- url: https://iaas.{region}.oraclecloud.com/20160918
  description: OCI Compute API server
  variables:
    region:
      default: us-ashburn-1
      description: OCI region identifier
security:
- ociSignature: []
tags:
- name: Images
paths:
  /images:
    get:
      operationId: listImages
      summary: Oracle Cloud List Images
      description: Lists available images in the specified compartment.
      tags:
      - Images
      parameters:
      - name: compartmentId
        in: query
        required: true
        description: The OCID of the compartment.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      - name: operatingSystem
        in: query
        required: false
        description: The image operating system.
        schema:
          type: string
        example: example-value
      - name: limit
        in: query
        required: false
        description: Maximum number of items to return.
        schema:
          type: integer
        example: 1
      - name: page
        in: query
        required: false
        description: Pagination token.
        schema:
          type: string
        example: example-value
      responses:
        '200':
          description: Successfully retrieved list of images.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Image'
              examples:
                ListImages200Example:
                  summary: Default listImages 200 response
                  x-microcks-default: true
                  value:
                  - id: ocid1.image.oc1.iad.abcdefg123456
                    compartmentId: ocid1.resource.oc1.iad.abcdefg123456
                    displayName: Oracle-Linux-8.8-2026.01.01-0
                    operatingSystem: Oracle Linux
                    operatingSystemVersion: '8.8'
                    lifecycleState: PROVISIONING
                    sizeInMBs: 47694
                    timeCreated: '2026-04-18T10:30:00Z'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /images/{imageId}:
    get:
      operationId: getImage
      summary: Oracle Cloud Get Image
      description: Gets the specified image.
      tags:
      - Images
      parameters:
      - name: imageId
        in: path
        required: true
        description: The OCID of the image.
        schema:
          type: string
        example: ocid1.resource.oc1.iad.abcdefg123456
      responses:
        '200':
          description: Successfully retrieved image.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Image'
              examples:
                GetImage200Example:
                  summary: Default getImage 200 response
                  x-microcks-default: true
                  value:
                    id: ocid1.image.oc1.iad.abcdefg123456
                    compartmentId: ocid1.resource.oc1.iad.abcdefg123456
                    displayName: Oracle-Linux-8.8-2026.01.01-0
                    operatingSystem: Oracle Linux
                    operatingSystemVersion: '8.8'
                    lifecycleState: PROVISIONING
                    sizeInMBs: 47694
                    timeCreated: '2026-04-18T10:30:00Z'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                GetImage404Example:
                  summary: Default getImage 404 response
                  x-microcks-default: true
                  value:
                    code: NotAuthorizedOrNotFound
                    message: Authorization failed or requested resource not found.
                    status: 404
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Error:
      type: object
      description: Error response from OCI API.
      properties:
        code:
          type: string
          description: A short error code.
          example: NotAuthorizedOrNotFound
        message:
          type: string
          description: A human-readable error message.
          example: Authorization failed or requested resource not found.
        status:
          type: integer
          description: HTTP status code.
          example: 404
    Image:
      type: object
      description: A boot disk image for launching compute instances.
      properties:
        id:
          type: string
          description: The OCID of the image.
          example: ocid1.image.oc1.iad.abcdefg123456
        compartmentId:
          type: string
          description: The OCID of the compartment.
          example: ocid1.resource.oc1.iad.abcdefg123456
        displayName:
          type: string
          description: A user-friendly name.
          example: Oracle-Linux-8.8-2026.01.01-0
        operatingSystem:
          type: string
          description: The image operating system.
          example: Oracle Linux
        operatingSystemVersion:
          type: string
          description: The image operating system version.
          example: '8.8'
        lifecycleState:
          type: string
          enum:
          - PROVISIONING
          - IMPORTING
          - AVAILABLE
          - EXPORTING
          - DISABLED
          - DELETED
          example: PROVISIONING
        sizeInMBs:
          type: integer
          description: Size of the image in megabytes.
          example: 47694
        timeCreated:
          type: string
          format: date-time
          example: '2026-04-18T10:30:00Z'
  securitySchemes:
    ociSignature:
      type: http
      scheme: bearer
      description: OCI request signature authentication using API signing keys.