autonomous_database_backups

Creates, updates, deletes, gets or lists an autonomous_database_backups resource.

Overview

Name	autonomous_database_backups
Type	Resource
Id	oci.database.autonomous_database_backups

Fields

The following fields are returned by SELECT queries:

get

The Autonomous AI Database backup.

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup.
autonomousDatabaseId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database.
backupDestinationDetails	object	Backup destination details
compartmentId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
databaseSizeInTBs	number (integer)	The size of the database in terabytes at the time the backup was taken.
dbVersion	string	A valid Oracle AI Database version for Autonomous AI Database. When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. For new databases, it is recommended to use either 19c or 26ai. Note Starting December 2026, 23ai will not be supported as a valid value for this parameter.
displayName	string	The user-friendly name for the backup. The name does not have to be unique.
infrastructureType	string	The infrastructure type this resource belongs to. (CLOUD, CLOUD_AT_CUSTOMER)
isAutomatic	boolean	Indicates whether the backup is user-initiated or automatic.
isRestorable	boolean	Indicates whether the backup can be used to restore the associated Autonomous AI Database.
keyStoreId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault.
keyStoreWalletName	string	The wallet name for Oracle Key Vault.
kmsKeyId	string	The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId	string	The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances.
lifecycleDetails	string	Additional information about the current lifecycle state.
lifecycleState	string	The current state of the backup. (CREATING, ACTIVE, DELETING, DELETED, FAILED, UPDATING)
region	string	Name of the region in which backup is taken in.
retentionPeriodInDays	integer	Retention period, in days, for long-term backups
sizeInTBs	number (double)	The backup size in terrabytes (TB).
sourceDatabaseDetails	object	Source Autonomous AI Database details.
timeAvailableTill	string (date-time)	Timestamp until when the backup will be available
timeEnded	string (date-time)	The date and time the backup completed.
timeStarted	string (date-time)	The date and time the backup started.
type	string	The type of backup. (INCREMENTAL, FULL, LONGTERM, VIRTUAL_FULL, CUMULATIVE_INCREMENTAL, ROLL_FORWARD_IMAGE_COPY)
vaultId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and secretId are required for Customer Managed Keys.

list

An Autonomous AI Database backup.<br />To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).<br /> <br />Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.<br />

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup.
autonomousDatabaseId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database.
backupDestinationDetails	object	Backup destination details
compartmentId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
databaseSizeInTBs	number (integer)	The size of the database in terabytes at the time the backup was taken.
dbVersion	string	A valid Oracle AI Database version for Autonomous AI Database. When you specify 23ai for dbversion, the system will provision a 23ai database, but the UI will display it as 26ai. When you specify 26ai for dbversion, the system will provision and display a 26ai database as expected. For new databases, it is recommended to use either 19c or 26ai. Note Starting December 2026, 23ai will not be supported as a valid value for this parameter.
displayName	string	The user-friendly name for the backup. The name does not have to be unique.
infrastructureType	string	The infrastructure type this resource belongs to. (CLOUD, CLOUD_AT_CUSTOMER)
isAutomatic	boolean	Indicates whether the backup is user-initiated or automatic.
isRestorable	boolean	Indicates whether the backup can be used to restore the associated Autonomous AI Database.
keyStoreId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the key store of Oracle Vault.
keyStoreWalletName	string	The wallet name for Oracle Key Vault.
kmsKeyId	string	The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
kmsKeyVersionId	string	The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous AI Database Serverless does not use key versions, hence is not applicable for Autonomous AI Database Serverless instances.
lifecycleDetails	string	Additional information about the current lifecycle state.
lifecycleState	string	The current state of the backup. (CREATING, ACTIVE, DELETING, DELETED, FAILED, UPDATING)
region	string	Name of the region in which backup is taken in.
retentionPeriodInDays	integer	Retention period, in days, for long-term backups
sizeInTBs	number (double)	The backup size in terrabytes (TB).
sourceDatabaseDetails	object	Source Autonomous AI Database details.
timeAvailableTill	string (date-time)	Timestamp until when the backup will be available
timeEnded	string (date-time)	The date and time the backup completed.
timeStarted	string (date-time)	The date and time the backup started.
type	string	The type of backup. (INCREMENTAL, FULL, LONGTERM, VIRTUAL_FULL, CUMULATIVE_INCREMENTAL, ROLL_FORWARD_IMAGE_COPY)
vaultId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure [vault](/Content/KeyManagement/Concepts/keyoverview.htm#concepts). This parameter and secretId are required for Customer Managed Keys.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	autonomousDatabaseBackupId, region	opc-request-id	Gets information about the specified Autonomous AI Database backup.
list	select	region	autonomousDatabaseId, compartmentId, limit, page, sortBy, sortOrder, lifecycleState, displayName, type, backupDestinationId, keyStoreId, infrastructureType, opc-request-id	Gets a list of Autonomous AI Database backups based on either the autonomousDatabaseId or compartmentId specified as a query parameter.<br />
create	insert	region, autonomousDatabaseId	opc-retry-token, opc-request-id	Creates a new Autonomous AI Database backup for the specified database based on the provided request parameters.<br />
update	update	autonomousDatabaseBackupId, region	if-match, opc-request-id	Updates the Autonomous AI Database backup of the specified database based on the request parameters.<br />
delete	delete	autonomousDatabaseBackupId, region	if-match, opc-request-id	Deletes a long-term backup. You cannot delete other backups using this API.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
autonomousDatabaseBackupId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
autonomousDatabaseId	string	The database [OCID](/Content/General/Concepts/identifiers.htm).
backupDestinationId	string	A filter to return only resources that have the given backup destination id.
compartmentId	string	The compartment [OCID](/Content/General/Concepts/identifiers.htm).
displayName	string	A filter to return only resources that match the entire display name given. The match is not case sensitive.
if-match	string	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.
infrastructureType	string	A filter to return only resources that match the given Infrastructure Type.
keyStoreId	string	A filter to return only resources that have the given key store id.
lifecycleState	string	A filter to return only resources that match the given lifecycle state exactly.
limit	integer	The maximum number of items to return per page.
opc-request-id	string	Unique identifier for the request.
opc-retry-token	string	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 may be rejected).
page	string	The pagination token to continue listing from.
sortBy	string	The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: If you do not include the availability domain filter, the resources are grouped by availability domain, then sorted.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC).
type	string	A filter to return only backups that matches with the given type of Backup.

SELECT examples

get

Gets information about the specified Autonomous AI Database backup.

SELECT
id,
autonomousDatabaseId,
backupDestinationDetails,
compartmentId,
databaseSizeInTBs,
dbVersion,
displayName,
infrastructureType,
isAutomatic,
isRestorable,
keyStoreId,
keyStoreWalletName,
kmsKeyId,
kmsKeyVersionId,
lifecycleDetails,
lifecycleState,
region,
retentionPeriodInDays,
sizeInTBs,
sourceDatabaseDetails,
timeAvailableTill,
timeEnded,
timeStarted,
type,
vaultId
FROM oci.database.autonomous_database_backups
WHERE autonomousDatabaseBackupId = '{{ autonomousDatabaseBackupId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Gets a list of Autonomous AI Database backups based on either the autonomousDatabaseId or compartmentId specified as a query parameter.<br />

SELECT
id,
autonomousDatabaseId,
backupDestinationDetails,
compartmentId,
databaseSizeInTBs,
dbVersion,
displayName,
infrastructureType,
isAutomatic,
isRestorable,
keyStoreId,
keyStoreWalletName,
kmsKeyId,
kmsKeyVersionId,
lifecycleDetails,
lifecycleState,
region,
retentionPeriodInDays,
sizeInTBs,
sourceDatabaseDetails,
timeAvailableTill,
timeEnded,
timeStarted,
type,
vaultId
FROM oci.database.autonomous_database_backups
WHERE region = '{{ region }}' -- required
AND autonomousDatabaseId = '{{ autonomousDatabaseId }}'
AND compartmentId = '{{ compartmentId }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
AND displayName = '{{ displayName }}'
AND type = '{{ type }}'
AND backupDestinationId = '{{ backupDestinationId }}'
AND keyStoreId = '{{ keyStoreId }}'
AND infrastructureType = '{{ infrastructureType }}'
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples

create

Creates a new Autonomous AI Database backup for the specified database based on the provided request parameters.<br />

INSERT INTO oci.database.autonomous_database_backups (
autonomousDatabaseId,
backupDestinationDetails,
displayName,
isLongTermBackup,
retentionPeriodInDays,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ autonomousDatabaseId }}' /* required */,
'{{ backupDestinationDetails }}',
'{{ displayName }}',
{{ isLongTermBackup }},
{{ retentionPeriodInDays }},
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
autonomousDatabaseId,
backupDestinationDetails,
compartmentId,
databaseSizeInTBs,
dbVersion,
displayName,
infrastructureType,
isAutomatic,
isRestorable,
keyStoreId,
keyStoreWalletName,
kmsKeyId,
kmsKeyVersionId,
lifecycleDetails,
lifecycleState,
region,
retentionPeriodInDays,
sizeInTBs,
sourceDatabaseDetails,
timeAvailableTill,
timeEnded,
timeStarted,
type,
vaultId
;

Manifest

# Description fields are for documentation purposes
- name: autonomous_database_backups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the autonomous_database_backups resource.
  - name: autonomousDatabaseId
    value: "{{ autonomousDatabaseId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the Autonomous AI Database backup.
  - name: backupDestinationDetails
    description: |
      Backup destination details
    value:
      backupRetentionPolicyOnTerminate: "{{ backupRetentionPolicyOnTerminate }}"
      dbrsPolicyId: "{{ dbrsPolicyId }}"
      id: "{{ id }}"
      internetProxy: "{{ internetProxy }}"
      isRemote: {{ isRemote }}
      isRetentionLockEnabled: {{ isRetentionLockEnabled }}
      remoteRegion: "{{ remoteRegion }}"
      type: "{{ type }}"
      vpcPassword: "{{ vpcPassword }}"
      vpcUser: "{{ vpcUser }}"
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The user-friendly name for the backup. The name does not have to be unique.
  - name: isLongTermBackup
    value: {{ isLongTermBackup }}
    description: |
      Indicates whether the backup is long-term
  - name: retentionPeriodInDays
    value: {{ retentionPeriodInDays }}
    description: |
      Retention period, in days, for long-term backups
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    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 may be rejected). 
    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 may be rejected). 
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: Unique identifier for the request. 
    description: Unique identifier for the request. 

UPDATE examples

update

Updates the Autonomous AI Database backup of the specified database based on the request parameters.<br />

UPDATE oci.database.autonomous_database_backups
SET 
retentionPeriodInDays = {{ retentionPeriodInDays }}
WHERE 
autonomousDatabaseBackupId = '{{ autonomousDatabaseBackupId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
autonomousDatabaseId,
backupDestinationDetails,
compartmentId,
databaseSizeInTBs,
dbVersion,
displayName,
infrastructureType,
isAutomatic,
isRestorable,
keyStoreId,
keyStoreWalletName,
kmsKeyId,
kmsKeyVersionId,
lifecycleDetails,
lifecycleState,
region,
retentionPeriodInDays,
sizeInTBs,
sourceDatabaseDetails,
timeAvailableTill,
timeEnded,
timeStarted,
type,
vaultId;

DELETE examples

delete

Deletes a long-term backup. You cannot delete other backups using this API.

DELETE FROM oci.database.autonomous_database_backups
WHERE autonomousDatabaseBackupId = '{{ autonomousDatabaseBackupId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
;