Oracle

opencollection: 1.0.0
info:
  name: Oracle OCI Compute API
  version: '20160918'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Instances
    type: folder
  items:
  - info:
      name: Oracle List Instances
      type: http
    http:
      method: GET
      url: https://iaas.{region}.oraclecloud.com/20160918/instances
      params:
      - name: compartmentId
        value: ''
        type: query
        description: The OCID of the compartment. List operations return resources in the compartment and its sub-compartments
          unless specified otherwise.
      - name: availabilityDomain
        value: example_value
        type: 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.
      - name: displayName
        value: example_value
        type: query
        description: A filter to return only resources that match the given display name exactly
      - name: lifecycleState
        value: example_value
        type: query
        description: A filter to return only instances that match the given lifecycle state
      - name: limit
        value: ''
        type: 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.
      - name: page
        value: ''
        type: query
        description: For list pagination. The value of the opc-next-page response header from the previous list call.
      - name: sortBy
        value: ''
        type: query
        description: The field to sort by
      - name: sortOrder
        value: ''
        type: query
        description: The sort order, either ascending or descending
    docs: 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.
  - info:
      name: Oracle Launch an Instance
      type: http
    http:
      method: POST
      url: https://iaas.{region}.oraclecloud.com/20160918/instances
      headers:
      - name: opc-retry-token
        value: ''
      body:
        type: json
        data: '{}'
    docs: 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.
  - info:
      name: Oracle Get an Instance
      type: http
    http:
      method: GET
      url: https://iaas.{region}.oraclecloud.com/20160918/instances/:instanceId
      params:
      - name: instanceId
        value: ''
        type: path
        description: The OCID of the instance
    docs: Gets information about the specified instance, including its current lifecycle state, shape, image, networking details,
      and metadata.
  - info:
      name: Oracle Update an Instance
      type: http
    http:
      method: PUT
      url: https://iaas.{region}.oraclecloud.com/20160918/instances/:instanceId
      headers:
      - name: if-match
        value: ''
      params:
      - name: instanceId
        value: ''
        type: path
        description: The OCID of the instance
      body:
        type: json
        data: '{}'
    docs: 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.
  - info:
      name: Oracle Terminate an Instance
      type: http
    http:
      method: DELETE
      url: https://iaas.{region}.oraclecloud.com/20160918/instances/:instanceId
      headers:
      - name: if-match
        value: ''
      params:
      - name: instanceId
        value: ''
        type: path
        description: The OCID of the instance
      - name: preserveBootVolume
        value: 'true'
        type: query
        description: Specifies whether to delete or preserve the boot volume when terminating an instance. Defaults to false
          (delete the boot volume).
      - name: preserveDataVolumesCreatedAtLaunch
        value: 'true'
        type: query
        description: Specifies whether to delete or preserve data volumes created during launch when terminating an instance.
          Defaults to true (preserve).
    docs: 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.
  - info:
      name: Oracle Perform an Action on an Instance
      type: http
    http:
      method: POST
      url: https://iaas.{region}.oraclecloud.com/20160918/instances/:instanceId/actions/:action
      headers:
      - name: if-match
        value: ''
      params:
      - name: instanceId
        value: ''
        type: path
        description: The OCID of the instance
      - name: action
        value: STOP
        type: path
        description: The action to perform on the instance
    docs: 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.
- info:
    name: Shapes
    type: folder
  items:
  - info:
      name: Oracle List Shapes
      type: http
    http:
      method: GET
      url: https://iaas.{region}.oraclecloud.com/20160918/shapes
      params:
      - name: compartmentId
        value: ''
        type: query
        description: The OCID of the compartment. List operations return resources in the compartment and its sub-compartments
          unless specified otherwise.
      - name: availabilityDomain
        value: example_value
        type: query
        description: The name of the availability domain. If not specified, shapes across all availability domains in the
          compartment are listed.
      - name: imageId
        value: '500123'
        type: query
        description: The OCID of an image. If specified, only shapes compatible with the image are returned.
      - name: limit
        value: ''
        type: 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.
      - name: page
        value: ''
        type: query
        description: For list pagination. The value of the opc-next-page response header from the previous list call.
    docs: 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.
- info:
    name: Images
    type: folder
  items:
  - info:
      name: Oracle List Images
      type: http
    http:
      method: GET
      url: https://iaas.{region}.oraclecloud.com/20160918/images
      params:
      - name: compartmentId
        value: ''
        type: query
        description: The OCID of the compartment. List operations return resources in the compartment and its sub-compartments
          unless specified otherwise.
      - name: displayName
        value: example_value
        type: query
        description: A filter to return only resources that match the given display name exactly
      - name: operatingSystem
        value: example_value
        type: query
        description: The image operating system (e.g., Oracle Linux)
      - name: operatingSystemVersion
        value: example_value
        type: query
        description: The image operating system version (e.g., 8)
      - name: shape
        value: example_value
        type: query
        description: Shape name. If specified, only images compatible with the shape are returned.
      - name: lifecycleState
        value: example_value
        type: query
        description: A filter to return only images that match the given lifecycle state
      - name: sortBy
        value: TIMECREATED
        type: query
        description: The field to sort by
      - name: sortOrder
        value: ''
        type: query
        description: The sort order, either ascending or descending
      - name: limit
        value: ''
        type: 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.
      - name: page
        value: ''
        type: query
        description: For list pagination. The value of the opc-next-page response header from the previous list call.
    docs: 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.
  - info:
      name: Oracle Create an Image
      type: http
    http:
      method: POST
      url: https://iaas.{region}.oraclecloud.com/20160918/images
      headers:
      - name: opc-retry-token
        value: ''
      body:
        type: json
        data: '{}'
    docs: 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.
  - info:
      name: Oracle Get an Image
      type: http
    http:
      method: GET
      url: https://iaas.{region}.oraclecloud.com/20160918/images/:imageId
      params:
      - name: imageId
        value: ''
        type: path
        description: The OCID of the image
    docs: Gets the specified image, including its display name, lifecycle state, operating system, and size.
  - info:
      name: Oracle Update an Image
      type: http
    http:
      method: PUT
      url: https://iaas.{region}.oraclecloud.com/20160918/images/:imageId
      headers:
      - name: if-match
        value: ''
      params:
      - name: imageId
        value: ''
        type: path
        description: The OCID of the image
      body:
        type: json
        data: '{}'
    docs: Updates the display name and tags of the specified image. Avoid entering confidential information.
  - info:
      name: Oracle Delete an Image
      type: http
    http:
      method: DELETE
      url: https://iaas.{region}.oraclecloud.com/20160918/images/:imageId
      headers:
      - name: if-match
        value: ''
      params:
      - name: imageId
        value: ''
        type: path
        description: The OCID of the image
    docs: Deletes the specified image. Note that platform images provided by Oracle cannot be deleted.
- info:
    name: VNIC Attachments
    type: folder
  items:
  - info:
      name: Oracle List Vnic Attachments
      type: http
    http:
      method: GET
      url: https://iaas.{region}.oraclecloud.com/20160918/vnicAttachments
      params:
      - name: compartmentId
        value: ''
        type: query
        description: The OCID of the compartment. List operations return resources in the compartment and its sub-compartments
          unless specified otherwise.
      - name: instanceId
        value: '500123'
        type: query
        description: The OCID of the instance to filter by
      - name: availabilityDomain
        value: example_value
        type: query
        description: The name of the availability domain to filter by
      - name: limit
        value: ''
        type: 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.
      - name: page
        value: ''
        type: query
        description: For list pagination. The value of the opc-next-page response header from the previous list call.
    docs: Lists the VNIC attachments in the specified compartment. A VNIC attachment represents the connection between an
      instance and a VNIC.
- info:
    name: Volume Attachments
    type: folder
  items:
  - info:
      name: Oracle List Volume Attachments
      type: http
    http:
      method: GET
      url: https://iaas.{region}.oraclecloud.com/20160918/volumeAttachments
      params:
      - name: compartmentId
        value: ''
        type: query
        description: The OCID of the compartment. List operations return resources in the compartment and its sub-compartments
          unless specified otherwise.
      - name: instanceId
        value: '500123'
        type: query
        description: The OCID of the instance to filter by
      - name: volumeId
        value: '500123'
        type: query
        description: The OCID of the volume to filter by
      - name: availabilityDomain
        value: example_value
        type: query
        description: The name of the availability domain to filter by
      - name: limit
        value: ''
        type: 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.
      - name: page
        value: ''
        type: query
        description: For list pagination. The value of the opc-next-page response header from the previous list call.
    docs: Lists the volume attachments in the specified compartment. You can filter by instance OCID or volume OCID.
- info:
    name: Console Connections
    type: folder
  items:
  - info:
      name: Oracle List Instance Console Connections
      type: http
    http:
      method: GET
      url: https://iaas.{region}.oraclecloud.com/20160918/instanceConsoleConnections
      params:
      - name: compartmentId
        value: ''
        type: query
        description: The OCID of the compartment. List operations return resources in the compartment and its sub-compartments
          unless specified otherwise.
      - name: instanceId
        value: '500123'
        type: query
        description: The OCID of the instance to filter by
      - name: limit
        value: ''
        type: 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.
      - name: page
        value: ''
        type: query
        description: For list pagination. The value of the opc-next-page response header from the previous list call.
    docs: 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.
bundled: true