openapi: 3.2.0 info: description: Use the OCI Cache API to create and manage clusters. A cluster is a memory-based storage solution. For more information, see [OCI Cache](/iaas/Content/ocicache/home.htm). title: OCI Cache Oci Cache Backup API version: '20220315' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/0c0709de34f2014ed9d1948ceeb3f59f7c24fee03209fa8269bdb6c37117b40d.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the OCI Cache 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/0c0709de34f2014ed9d1948ceeb3f59f7c24fee03209fa8269bdb6c37117b40d.yaml what: the harvested document for OCI Cache API servers: - url: http://127.0.0.1/20220315 - url: https://127.0.0.1/20220315 tags: - name: ociCacheBackup paths: /ociCacheBackups: get: description: Returns a list of OCI Cache Backups. operationId: ListOciCacheBackups parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/OciCacheBackupLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/OciCacheBackupIdentifierQueryParam' - $ref: '#/components/parameters/OciCacheBackupSourceClusterIdQueryParam' - $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 OCI Cache Backup 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/OciCacheBackupCollection' 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 OCI Cache Backups in a compartment tags: - ociCacheBackup x-related-resource: '#/definitions/OciCacheBackupSummary' post: description: Creates a new OCI Cache Backup. operationId: CreateOciCacheBackup parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The OCI Cache Backup will be created. 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 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 content: application/json: schema: $ref: '#/components/schemas/OciCacheBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new OCI Cache Backup tags: - ociCacheBackup x-related-resource: '#/definitions/OciCacheBackup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOciCacheBackupDetails' description: Details for the new OCI Cache Backup. required: true /ociCacheBackups/{ociCacheBackupId}: delete: description: Deletes an OCI Cache Backup resource by identifier operationId: DeleteOciCacheBackup parameters: - $ref: '#/components/parameters/OciCacheBackupIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The OCI Cache Backup 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 OCI Cache Backup tags: - ociCacheBackup x-related-resource: '#/definitions/OciCacheBackup' get: description: Gets an OCI Cache Backup by identifier operationId: GetOciCacheBackup parameters: - $ref: '#/components/parameters/OciCacheBackupIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the OCI Cache Backup 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/OciCacheBackup' 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 OCI Cache Backup tags: - ociCacheBackup x-related-resource: '#/definitions/OciCacheBackup' put: description: Updates the OCI Cache Backup operationId: UpdateOciCacheBackup parameters: - $ref: '#/components/parameters/OciCacheBackupIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The OCI Cache backup was updated. 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 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 content: application/json: schema: $ref: '#/components/schemas/OciCacheBackup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the OCI Cache Backup identified by the id tags: - ociCacheBackup x-related-resource: '#/definitions/OciCacheBackup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOciCacheBackupDetails' description: The information to be updated. required: true /ociCacheBackups/{ociCacheBackupId}/actions/changeCompartment: post: description: Moves an OCI Cache Backup resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeOciCacheBackupCompartment parameters: - $ref: '#/components/parameters/OciCacheBackupIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The OCI Cache Backup resource will be moved into a different compartment. 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 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - ociCacheBackup x-related-resource: '#/definitions/OciCacheBackup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeOciCacheBackupCompartmentDetails' description: The information to be updated. required: true /ociCacheBackups/{ociCacheBackupId}/actions/exportToObjectStorage: post: description: 'Initiates an asynchronous export of the backup’s RDB file(s) to the specified Object Storage bucket. The service generates the object names. For sharded backups, one object is written per shard under the optional prefix. ' operationId: ExportOciCacheBackupToObjectStorage parameters: - $ref: '#/components/parameters/OciCacheBackupIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The OCI Cache Backup will be exported to object storage. 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 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Export an OCI Cache Backup to Object Storage tags: - ociCacheBackup x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/OciCacheBackup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ExportOciCacheBackupToObjectStorageDetails' description: The destination Object Storage information for the export. required: true components: parameters: PaginationTokenQueryParam: description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. in: query name: page x-default-description: 'null' schema: type: string 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. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId x-default-description: 'null' 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 OciCacheBackupSourceClusterIdQueryParam: description: A filter to return the OCI Cache Backup resources, whose source cluster ID matches with the given source cluster ID. in: query name: sourceClusterId required: false x-default-description: 'null' schema: type: string OciCacheBackupLifecycleStateQueryParam: description: A filter to return the OCI Cache Backup resources, whose lifecycle state matches with the given lifecycle state. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/OciCacheBackup/lifecycleState' schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC OciCacheBackupIdentifierPathParam: description: Unique OCI Cache Backup identifier. in: path name: ociCacheBackupId required: true schema: type: string OciCacheBackupIdentifierQueryParam: description: Unique OCI Cache Backup identifier. in: query name: ociCacheBackupId x-default-description: 'null' schema: type: string RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 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 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string schemas: OciCacheBackupSummary: description: Summary of the OCI Cache Backup. properties: backupSizeInGBs: description: Backup size in GB. format: float type: number backupSource: default: REPLICA description: Specifies whether the backup was created from a replica or primary node type: string x-obmcs-enumref: '#/definitions/OciCacheBackup/backupSource' backupType: description: Backup Type. enum: - MANUAL - AUTOMATED type: string clusterMode: description: Specifies whether the cluster is sharded or non-sharded. type: string x-obmcs-enumref: '#/definitions/RedisCluster/clusterMode' compartmentId: description: Compartment identifier 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: Backup identifier, can be renamed 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: Unique identifier that is immutable on creation type: string lifecycleState: description: The current state of the backup. type: string x-obmcs-enumref: '#/definitions/OciCacheBackup/lifecycleState' retentionPeriodInDays: default: 35 description: Backup retention period in days. type: integer sourceClusterId: description: The source OCI Cache Cluster OCID. 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 backup was created. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. format: date-time type: string timeUpdated: description: The date and time the backup was updated. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - clusterMode - sourceClusterId - freeformTags - definedTags type: object Error: description: Specifies details for an error. properties: code: description: A machine-usable code for the error that occured. type: string message: description: A human-readable error string for the error that occured. type: string required: - code - message UpdateOciCacheBackupDetails: description: The OCI Cache backup information to be updated. 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 description: description: Backup description maxLength: 2000 minLength: 1 type: string displayName: description: Backup display name maxLength: 255 minLength: 1 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 retentionPeriodInDays: default: 35 description: Backup retention period in days. type: integer type: object ChangeOciCacheBackupCompartmentDetails: description: The OCI Cache backup information to move it a different compartment. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm#Oracle) of the compartment into which the backup should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object CreateOciCacheBackupDetails: description: The information to create a new OCI Cache Backup. properties: backupSource: default: REPLICA description: Specifies whether the backup was created from a replica or primary node type: string x-obmcs-enumref: '#/definitions/OciCacheBackup/backupSource' compartmentId: description: Compartment identifier maxLength: 255 minLength: 1 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 description: description: Backup description maxLength: 2000 minLength: 1 type: string displayName: description: Backup display name. maxLength: 255 minLength: 1 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 retentionPeriodInDays: default: 35 description: Backup retention period in days. type: integer sourceClusterId: description: OCI Cache cluster identifier maxLength: 255 minLength: 1 type: string required: - sourceClusterId - compartmentId - displayName type: object ExportOciCacheBackupToObjectStorageDetails: description: Parameters to export an OCI Cache Backup’s RDB file(s) to Object Storage. properties: bucketName: description: The target Object Storage bucket name. maxLength: 256 minLength: 1 type: string namespaceName: description: The Object Storage namespace name. maxLength: 256 minLength: 1 type: string prefix: description: Optional prefix under which the service will place the exported object(s). maxLength: 768 minLength: 0 type: string required: - namespaceName - bucketName type: object OciCacheBackup: description: OCI Cache cluster backup information properties: backupSizeInGBs: description: Backup size in GB. format: float type: number backupSource: default: REPLICA description: Specifies whether the backup was created from a replica or primary node enum: - REPLICA - PRIMARY type: string backupType: description: Backup Type. enum: - MANUAL - AUTOMATED type: string clusterMemoryInGBs: description: The amount of memory allocated to the cluster, in gigabytes. format: float maximum: 500 minimum: 2 type: number clusterMode: description: Specifies whether the cluster is sharded or non-sharded. type: string x-obmcs-enumref: '#/definitions/RedisCluster/clusterMode' compartmentId: description: Backup compartment identifier 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 description: description: Backup description type: string displayName: description: Backup display name 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: Unique identifier that is immutable on creation type: string lifecycleState: description: The current state of the backup. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string retentionPeriodInDays: default: 35 description: Backup retention period in days. type: integer shardCount: description: The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED. type: integer softwareVersion: description: The OCI Cache engine version that the cluster is running. type: string x-obmcs-enumref: '#/definitions/RedisCluster/softwareVersion' sourceClusterId: description: The source OCI Cache Cluster OCID. 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 backup was created. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. format: date-time type: string timeUpdated: description: The date and time the backup was updated. An [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) formatted datetime string. format: date-time type: string required: - id - compartmentId - lifecycleState - displayName - sourceClusterId - clusterMode - softwareVersion - backupSizeInGBs type: object OciCacheBackupCollection: description: Results of an OCI Cache backup search. Contains the OCI Cache Backup items and other information, such as metadata. properties: items: description: List of OCI Cache backups. items: $ref: '#/components/schemas/OciCacheBackupSummary' type: array required: - items 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 securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' type: object description: 'Security attributes for redis cluster resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' 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-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.pic.redisservice