API Reference

Search archives

get
https://{host}/platform/admindata/v1/archives

Returns list of archives.

An archive is a copy of a database, securable, or exposure set that is stored in the Intelligent Risk Platform Data Vault.

Data Vault supports three types (sourceType) of archives: deleted databases, snapshot databases, and archive databases.

  • An Archive Database is a type (2) of database archive that was created using Create Archive from EDM operation.
  • A Delete Database is a type (0) of database archive that was created automatically when a database was deleted from a managed server instance.
  • A Snapshot Database is a type (1) of database archive that was created using the Create Archive from Snapshot operation.

Every archive is defined by its storageType (permanent or temporary). A temporary archive has an expiration date and is automically deleted from Data Vault on that date.

🍐

Role-based Permissions

To perform this operation, a principal must belong to a group that has been assigned the Data Admin role. To learn more about role-based permissions, see Access Controls.

🪰

Entitlements

RI-DATAVAULT

Query Params
string

Query string to select response data based on property values. Supported properties: archiveName, archiveId, archivedBy, serverName, createdAt, createdBy, expirationDate, serverType, sourceTypeId, storageTypeId, tagIds . Depending on the property, you may use comparison operators, list operators, and logical operators.

PropertyTypeComparisonList
archiveIdNumber=, !=IN, NOT IN
archiveNameString=, !=, LIKE, NOT LIKEIN, NOT IN
archiveSubTypeString=, !=, LIKE, NOT LIKEIN, NOT IN
archiveTypeString=, !=, LIKE, NOT LIKEIN, NOT IN
archivedByString=, !=, LIKE, NOT LIKEIN, NOT IN
createdAtYYYY-MM-DD=, !=, >, >=, <, <=, LIKE, NOT LIKE
createdByString=, !=, LIKE, NOT LIKEIN, NOT IN
databaseTypeString=, !=, LIKE, NOT LIKEIN, NOT IN
expirationDateYYYY-MM-DD=, !=, >, >=, <, <=, LIKE, NOT LIKE
ownerString=, !=, LIKE, NOT LIKEIN, NOT IN
serverNameString=, !=, LIKE, NOT LIKEIN, NOT IN
serverTypeString=, !=, LIKE, NOT LIKEIN, NOT IN
sizeInMbNumber=, !=, >, >=, <, <=
sourceTypeIdNumber=, !=, LIKE, NOT LIKEIN, NOT IN
sourceTypeString=, !=, LIKE, NOT LIKEIN, NOT IN
storageTypeIdNumber=, !=, LIKE, NOT LIKEIN, NOT IN
storageTypeNumber=, !=, LIKE, NOT LIKEIN, NOT IN
tagIdsNumber=, !=IN, NOT IN

See Filtering Responses.

string
Defaults to archiveName ASC

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

Supported properties: archivedBy, archiveId, archiveName, archiveSubType, archiveType, createdAt, createdBy, databaseType, expirationDate, owner, serverName, serverType, sizeInMb, storageType, storageTypeId, tagIds.
See Response Pagination.

int32
1 to 1000
Defaults to 100

Number of records to display on the page.

int32
≥ 0
Defaults to 0

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

Responses

Updated 6 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 6 months ago