API Reference

List archives by server instance

get
https://{host}/databridge/v1/sql-instances//Archives

Returns a list of the archived databases for the specified managed SQL Server instance.

An archive is a copy of a database that is stored in the Intelligent Risk Platform Data Vault. Data Vault is a separately licensed application that enables Intelligent Risk Platform tenants to manage archives of data servers and databases.

🍐

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
NONOYES

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

Path Params
string
required

Name of managed SQL Server instance.

Query Params
string

Query string to select response data base on property values.

PropertyTypeComparisonList
archiveIdString=, !=, >, <, >=, <=IN
nameString=, !=, >, <, >=, <=, LIKEIN
sizeInMbNumber=, !=, >, <, >=, <=IN
createDateDate=, !=, >, <, >=, <=IN
expiryDateDate=, !=, >, <, >=, <=IN
createdByString=, !=, >, <, >=, <=, LIKEIN
storageTypeIdNumber=, !=, >, <, >=, <=IN
string
Defaults to createDate DESC

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending). This operation supports sorting response data based by the following property values: archiveId, createDate, createdBy, expiryDate, name , serverName, sizeInMb , and storageTypeId.

int32
1 to 5000
Defaults to 5000

Numbe of records to return per page.

int32
0 to 2147483647
Defaults to 0

Number of the page displaying the returned records, starting at 0.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Bad Request. Some of the provided parameters were not valid.

404

Not found. The entity you are trying to interact with does not
exist.

500

Internal Server Error. If the problem persists you may want to
contact the Administrator.

Updated 11 months ago

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