API Reference

Archive database

post
https://{host}/databridge/v1/sql-instances//Databases//archive

Creates an archive of the specified database.

An archive is a copy of a database that is stored in the Intelligent Risk Platform Data Vault. Every archive is defined by its storageType, which determines whether the archive is permanent or temporary. Temporary archives are defined by an expirationDate that specifies the date that the archive is deleted from Data Vault.

This operation creates a new archive of the specified database. The source type of the archive is Archive Database. If no expirationDate is specified, the storage type of archive is permanent.

🍐

Entitlements

This operation requires the RI-DATAVAULT entitlement. Data Vault is a separately licensed application that enables Intelligent Risk Platform tenants to manage archives of data servers and databases.

🍐

Role-based Permissions

To perform this operation, a principal must belong to a group that has been assigned the appropriate role-based permissions. The table identifies the roles with permission to perform this operation.

ConsumerContributorData Bridge Admin
NOYESYES

To learn more about role-based permissions in Data Bridge, see Access Controls.

Path Params
string
required

Name of managed SQL Server instance.

string
required

Name of database.

Body Params
string

Timestamp in 8601 format, i.e. YYYY-MM-DDThh:mm:ss.sss

Headers
uuid
required
Defaults to xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

ID of resource group. To learn more, see Resource Groups

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Updated 12 months ago

Language
URL
Response 
 Choose an example:
application/json
text/plain
text/json
Updated 12 months ago