Admin Data API Overview

Resources for administrating Intelligent Risk Platform data.

Overview

Admin Data API exposes a collection of API operations to access and manage platform resources that are mutated to carry out admin-centric activities without redefining data security definition.

The Admin Data API consists of three collections: Archives, Securables, and Snaphots.

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 of database archive that was created using Create Archive from EDM operation.
  • A Delete Database is a type of database archive that was created automatically when a database was deleted from a managed server instance.
  • A Snapshot Database is a type 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.

Operations

All archive operation require the RI-DATAVAULT entitlement.

OperationEndpointDescription
Search ArchivesGET /platform/admindata /v1/archivesReturns list of archives.
Get ArchiveGET /platform/admindata /v1/archive/{archiveId}Returns archive.
Update ArchivePATCH /platform/admindata /v1/archive/{archiveId}Updates archive.
Delete ArchiveDELETE /platform/admindata /v1/archive/{archiveId}Deletes archive.
Restore ArchivePOST /platform/admindata /v1/archive/{archiveId}/restoreRestores archive.

Securables

A securable is a logical container of data that is owned by a group or principal. The owner of a securable has exclusive access to that securable and all child data. For example, the owner of an exposure set controls access to the exposures, analysis results, and variations in that exposure set.

The Intelligent Risk Platform supports four types of securables:

  • Business Hierarchy Set
  • Database
  • Exposure Set
  • Program Set
  • Server
  • Share Set

Operations

OperationEndpointDescription
Search SecurablesGET /platform/admindata/v1/securables`Returns list of securables.
Get SecurableGET /platform/admindata/v1/securable/ {securableId}Returns a securable.
Update SecurablePATCH /platform/admindata/v1/securable/ {securableId}Updates a securable.
Delete SecurableDELETE /platform/admindata/v1/securable/ {securableId}Deletes a securable.
Archive SecurablePOST /platform/admindata/v1/securable/ {securableId}/archiveArchives a securable.

Snapshots

A snapshot is a read-only, static version of a data server. Intelligent Risk Platform automatically takes periodic snapshots of Intelligent Risk Platform managed server instances.

The number snapshots captured each day depends on the tenant's Data Vault package. The resource quota is managed and tracked in the tenant's RI-DATAVAULT resource group. The tenant is allocated a quota of resources based on the Data Vault package licensed.

All snapshot operation require the RI-DATAVAULT entitlement.

OperationEndpointDescription
Search SnapshotsGET /platform/admindata/v1/databasesnapshotsReturns list of snapshots.
Get Database by SnapshotGET /platform/admindata/v1/snapshots/{snapshotId}/ databasesnapshots/{databaseSnapshotId}Returns database in specific snapshot.
Search Databases by SnapshotGET /platform/admindata/v1 /snapshots/{snapshotId}/ databasesnapshotsReturns list of databases in specific snapshot.
Archive SnapshotsPOST /platform/admindata/v1 /snapshots/{snapshotId}/ copy-to-archiveArchives databases in specific snapshot.

Entitlements

Tenants with the RI-DATAVAULT entitlement can manage archives and database snapshots.

CollectionOperationEntitlementRole
ArchivesCreate ArchiveRI-DATAVAULTData Admin
ArchivesDelete ArchiveRI-DATAVAULTData Admin
ArchivesGet ArchiveRI-DATAVAULTData Admin
ArchivesRestore ArchiveRI-DATAVAULTData Admin
ArchivesSearch ArchiveRI-DATAVAULTData Admin
ArchivesUpdate ArchiveRI-DATAVAULTData Admin
SecurablesArchive SecurableRI-DATAVAULTData Admin
SnapshotsCreate Archive from SnapshotRI-DATAVAULTData Admin
SnapshotsGet Database by SnapshotRI-DATAVAULTData Admin
SnapshotsGet Database by SnapshotRI-DATAVAULTData Admin
SnapshotsSearch Databases by SnapshotRI-DATAVAULTData Admin
SnapshotsSearch SnapshotsRI-DATAVAULTData Admin

Admin Data Jobs

Client applications with the Data Admin role can run operations that initiate the following platform jobs:

Job TypeOperation
ARCHIVE_SECURABLEArchive Securable
AUTO_DELETE_ARCHIVEAuto-generated job.
COPY_TO_ARCHIVECreate Archive from Snapshot
DELETE_ARCHIVEDelete Archive
DELETE_SECURABLEDelete Securable
RESTORE_ARCHIVERestore Archive