Oracle Opensearch Cluster Backup API

openapi: 3.2.0
info:
  description: The OpenSearch service API provides access to OCI Search Service with OpenSearch.
  title: OpenSearch Service Opensearch Cluster Backup API
  version: '20180828'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/db7aead90481c47e0d0e3f85d7516754adc899cb5606ea20d87eb9c20d2c0d0e.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the OpenSearch Service API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/db7aead90481c47e0d0e3f85d7516754adc899cb5606ea20d87eb9c20d2c0d0e.yaml
    what: the harvested document for OpenSearch Service API
servers:
- url: http://127.0.0.1/20180828
- url: https://127.0.0.1/20180828
tags:
- name: opensearchClusterBackup
paths:
  /opensearchClusterBackups:
    get:
      description: 'Returns a list of OpensearchClusterBackups.

        '
      operationId: ListOpensearchClusterBackups
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/OpensearchClusterBackupLifecycleStateQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/OpensearchClusterBackupSourceClusterIdQueryParam'
      - $ref: '#/components/parameters/OpensearchClusterBackupIdentifierQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of OpensearchClusterBackupSummary objects.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpensearchClusterBackupCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Gets a list of all OpensearchClusterBackups in a compartment
      tags:
      - opensearchClusterBackup
      x-related-resource: '#/definitions/OpensearchClusterBackupCollection'
  /opensearchClusterBackups/{opensearchClusterBackupId}:
    delete:
      description: Deletes a OpensearchClusterBackup resource by identifier
      operationId: DeleteOpensearchClusterBackup
      parameters:
      - $ref: '#/components/parameters/OpensearchClusterBackupIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The OpensearchClusterBackup will be deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Delete a provisioned OpensearchClusterBackup
      tags:
      - opensearchClusterBackup
      x-related-resource: '#/definitions/OpensearchClusterBackup'
    get:
      description: Gets a OpensearchClusterBackup by identifier
      operationId: GetOpensearchClusterBackup
      parameters:
      - $ref: '#/components/parameters/OpensearchClusterBackupIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the OpensearchClusterBackup with the given id
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpensearchClusterBackup'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get OpensearchClusterBackup
      tags:
      - opensearchClusterBackup
    put:
      description: Updates the OpensearchClusterBackup
      operationId: UpdateOpensearchClusterBackup
      parameters:
      - $ref: '#/components/parameters/OpensearchClusterBackupIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The OpensearchClusterBackup will be updated.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update the OpensearchClusterBackup identified by the id
      tags:
      - opensearchClusterBackup
      x-related-resource: '#/definitions/OpensearchClusterBackup'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOpensearchClusterBackupDetails'
        description: Update the opensearch cluster backup details.
        required: true
components:
  parameters:
    CompartmentIdQueryParam:
      description: The ID of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call

        for a resource, set the `if-match` parameter to the value of the

        etag from a previous GET or POST response for that resource.

        The resource will be updated or deleted only if the etag you

        provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    OpensearchClusterBackupIdentifierPathParam:
      description: unique OpensearchClusterBackup identifier
      in: path
      name: opensearchClusterBackupId
      required: true
      schema:
        type: string
    DisplayNameQueryParam:
      description: A filter to return only resources that match the entire display name given.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    OpensearchClusterBackupSourceClusterIdQueryParam:
      description: A filter to return only resources that match the entire source cluster id given.
      in: query
      name: sourceOpensearchClusterId
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    PaginationTokenQueryParam:
      description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
      in: query
      name: page
      schema:
        type: string
        minLength: 1
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    OpensearchClusterBackupLifecycleStateQueryParam:
      description: A filter to return only resources their lifecycleState matches the given lifecycleState.
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/OpensearchClusterBackup/lifecycleState'
      schema:
        type: string
    OpensearchClusterBackupIdentifierQueryParam:
      description: unique OpensearchClusterBackup identifier
      in: query
      name: id
      x-default-description: 'null'
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either 'asc' or 'desc'.
      in: query
      name: sortOrder
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
  schemas:
    UpdateOpensearchClusterBackupDetails:
      description: Information about the cluster backup to update.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        displayName:
          description: The name of the cluster backup.
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
      required:
      - displayName
      type: object
    OpensearchClusterBackupCollection:
      description: The list of cluster backups returned in a cluster backup search.
      properties:
        items:
          description: The list of cluster backups.
          items:
            $ref: '#/components/schemas/OpensearchClusterBackupSummary'
          type: array
      required:
      - items
      type: object
    Error:
      description: Error Information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    OpensearchClusterBackupSummary:
      description: The summary of information about an OpenSearch cluster backup.
      properties:
        backupSize:
          description: The size in GB of the cluster backup.
          format: double
          type: number
        backupType:
          description: Specifies whether the cluster backup was created manually, or automatically as a scheduled backup.
          type: string
          x-obmcs-enumref: '#/definitions/OpensearchClusterBackup/backupType'
        compartmentId:
          description: The OCID of the compartment where the cluster backup is located.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        displayName:
          description: The name of the cluster backup. Avoid entering confidential information.
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        id:
          description: The OCID of the cluster backup.
          type: string
        lifecycleDetails:
          description: Additional information about the current lifecycle state of the cluster backup.
          type: string
        lifecycleState:
          description: The current state of the cluster backup.
          type: string
          x-obmcs-enumref: '#/definitions/OpensearchClusterBackup/lifecycleState'
        sourceClusterDisplayName:
          description: The name of the source OpenSearch cluster for the cluster backup.
          type: string
        sourceClusterId:
          description: The OCID of the source OpenSearch cluster for the cluster backup.
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: The date and time the cluster backup was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
          format: date-time
          type: string
        timeExpired:
          description: The date and time the cluster backup expires. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
          format: date-time
          type: string
        timeUpdated:
          description: The date and time the cluster backup was updated. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - backupType
      - sourceClusterId
      - lifecycleState
      type: object
    OpensearchClusterBackup:
      description: 'An OpenSearch cluster backup resource. An cluster is set of instances that provide OpenSearch functionality in OCI Search Service with OpenSearch.

        For more information, see [Cluster Backups](/iaas/Content/search-opensearch/Concepts/ociopensearchbackups.htm).

        '
      properties:
        backupSize:
          description: The size in GB of the cluster backup.
          format: double
          type: number
        backupType:
          description: Specifies whether the cluster backup was created manually, or automatically as a scheduled backup.
          enum:
          - SCHEDULED
          - MANUAL
          type: string
        bucketName:
          description: The name of the Object Storage bucket for the cluster backup.
          maxLength: 255
          minLength: 1
          type: string
        compartmentId:
          description: The OCID of the compartment where the cluster backup is located.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"foo-namespace": {"bar-key": "value"}}`

            '
          type: object
        displayName:
          description: The name of the cluster backup. Avoid entering confidential information.
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

            Example: `{"bar-key": "value"}`

            '
          type: object
        id:
          description: The OCID of the cluster backup.
          type: string
        lifecycleState:
          description: The current state of the cluster backup.
          enum:
          - CREATING
          - UPDATING
          - ACTIVE
          - DELETING
          - DELETED
          - FAILED
          type: string
        lifecyleDetails:
          description: Additional information about the current lifecycle state of the cluster backup.
          type: string
        namespace:
          description: The Object Storage namespace for the cluster backup.
          maxLength: 255
          minLength: 1
          type: string
        prefix:
          description: The prefix within the Object Storage bucket for the cluster backup.
          maxLength: 255
          minLength: 1
          type: string
        sourceClusterDisplayName:
          description: The name of the source OpenSearch cluster for the cluster backup.
          type: string
        sourceClusterId:
          description: The OCID of the source OpenSearch cluster for the cluster backup.
          maxLength: 255
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer and boolean types are supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: The date and time the cluster backup was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
          format: date-time
          type: string
        timeExpired:
          description: The date and time the cluster backup expires. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
          format: date-time
          type: string
        timeUpdated:
          description: The date and time the cluster backup was updated. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - backupType
      - sourceClusterId
      - lifecycleState
      type: object
  responses:
    default:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      type: integer
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        Example: `{"foo-namespace": {"bar-key": "value"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

        Example: `{"bar-key": "value"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object
x-oracle-package: com.oracle.pic.opensearch.mp